From 4fd8a668f18d1cd09b7ca70f4e131137078e68b5 Mon Sep 17 00:00:00 2001 From: "team-cdk-terrain[bot]" <254218809+team-cdk-terrain[bot]@users.noreply.github.com> Date: Fri, 8 May 2026 15:29:16 +0000 Subject: [PATCH 1/2] chore(deps): update by cdktn-io/cdktn-repository-manager@718a678 --- .github/workflows/build.yml | 39 +++++++++++++++++++ .github/workflows/force-release.yml | 48 +++++++++++++++++++++++ .github/workflows/release.yml | 60 +++++++++++++++++++++++++++++ .projen/tasks.json | 14 ++++++- package.json | 8 ++++ yarn.lock | 6 +-- 6 files changed, 171 insertions(+), 4 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 8dd2002d4..df895f914 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -138,6 +138,45 @@ jobs: run: cd .repo && npx projen package:js - name: Collect js artifact run: mv .repo/dist dist + package-java: + needs: build + runs-on: ubuntu-latest + permissions: + contents: read + if: ${{ !needs.build.outputs.self_mutation_happened }} + steps: + - uses: actions/setup-java@3a4f6e1af504cf6a31855fa899c6aa5355ba6c12 + with: + distribution: corretto + java-version: "11" + - uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e + with: + node-version: 20.16.0 + package-manager-cache: "false" + - name: Download build artifacts + uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e + with: + name: build-artifact + path: dist + - name: Restore build artifact permissions + run: cd dist && setfacl --restore=permissions-backup.acl + continue-on-error: true + - name: Checkout + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 + with: + ref: ${{ github.event.pull_request.head.ref }} + repository: ${{ github.event.pull_request.head.repo.full_name }} + path: .repo + - name: Install Dependencies + run: cd .repo && yarn install --check-files --frozen-lockfile + - name: Extract build artifact + run: tar --strip-components=1 -xzvf dist/js/*.tgz -C .repo + - name: Move build artifact out of the way + run: mv dist dist.old + - name: Create java artifact + run: cd .repo && npx projen package:java + - name: Collect java artifact + run: mv .repo/dist dist package-python: needs: build runs-on: ubuntu-latest diff --git a/.github/workflows/force-release.yml b/.github/workflows/force-release.yml index 1a70edbe2..f98f4daf5 100644 --- a/.github/workflows/force-release.yml +++ b/.github/workflows/force-release.yml @@ -142,6 +142,54 @@ jobs: NPM_REGISTRY: registry.npmjs.org NPM_TOKEN: ${{ secrets.NPM_TOKEN }} run: npx -p publib@latest publib-npm + release_maven: + name: Publish to Maven Central + needs: release + runs-on: ubuntu-latest + permissions: + contents: read + issues: write + if: ${{ inputs.publish_to_maven }} + steps: + - uses: actions/setup-java@3a4f6e1af504cf6a31855fa899c6aa5355ba6c12 + with: + distribution: corretto + java-version: "11" + - uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e + with: + node-version: 20.16.0 + package-manager-cache: "false" + - name: Download build artifacts + uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e + with: + name: build-artifact + path: dist + - name: Restore build artifact permissions + run: cd dist && setfacl --restore=permissions-backup.acl + continue-on-error: true + - name: Checkout + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 + with: + path: .repo + - name: Install Dependencies + run: cd .repo && yarn install --check-files --frozen-lockfile + - name: Extract build artifact + run: tar --strip-components=1 -xzvf dist/js/*.tgz -C .repo + - name: Move build artifact out of the way + run: mv dist dist.old + - name: Create java artifact + run: cd .repo && npx projen package:java + - name: Collect java artifact + run: mv .repo/dist dist + - name: Release + env: + MAVEN_SERVER_ID: central-ossrh + MAVEN_GPG_PRIVATE_KEY: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }} + MAVEN_GPG_PRIVATE_KEY_PASSPHRASE: ${{ secrets.MAVEN_GPG_PRIVATE_KEY_PASSPHRASE }} + MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }} + MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }} + MAVEN_OPTS: --add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.base/java.lang.reflect=ALL-UNNAMED --add-opens=java.base/java.text=ALL-UNNAMED --add-opens=java.desktop/java.awt.font=ALL-UNNAMED + run: npx -p publib@latest publib-maven release_pypi: name: Publish to PyPI needs: release diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 1ec8e5a67..9d454a9a7 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -182,6 +182,66 @@ jobs: VERSION: ${{ steps.extract-version.outputs.VERSION }} RUN_URL: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }} run: gh issue create --title "Publishing v$VERSION to npm failed" --body "See $RUN_URL" --label "failed-release" + release_maven: + name: Publish to Maven Central + needs: release + runs-on: ubuntu-latest + permissions: + contents: read + issues: write + if: needs.release.outputs.tag_exists != 'true' && needs.release.outputs.latest_commit == github.sha + steps: + - uses: actions/setup-java@3a4f6e1af504cf6a31855fa899c6aa5355ba6c12 + with: + distribution: corretto + java-version: "11" + - uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e + with: + node-version: 20.16.0 + package-manager-cache: "false" + - name: Download build artifacts + uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e + with: + name: build-artifact + path: dist + - name: Restore build artifact permissions + run: cd dist && setfacl --restore=permissions-backup.acl + continue-on-error: true + - name: Checkout + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 + with: + path: .repo + - name: Install Dependencies + run: cd .repo && yarn install --check-files --frozen-lockfile + - name: Extract build artifact + run: tar --strip-components=1 -xzvf dist/js/*.tgz -C .repo + - name: Move build artifact out of the way + run: mv dist dist.old + - name: Create java artifact + run: cd .repo && npx projen package:java + - name: Collect java artifact + run: mv .repo/dist dist + - name: Release + env: + MAVEN_SERVER_ID: central-ossrh + MAVEN_GPG_PRIVATE_KEY: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }} + MAVEN_GPG_PRIVATE_KEY_PASSPHRASE: ${{ secrets.MAVEN_GPG_PRIVATE_KEY_PASSPHRASE }} + MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }} + MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }} + MAVEN_OPTS: --add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.base/java.lang.reflect=ALL-UNNAMED --add-opens=java.base/java.text=ALL-UNNAMED --add-opens=java.desktop/java.awt.font=ALL-UNNAMED + run: npx -p publib@latest publib-maven + - name: Extract Version + id: extract-version + if: ${{ failure() }} + run: echo "VERSION=$(cat dist/version.txt)" >> $GITHUB_OUTPUT + shell: bash + - name: Create Issue + if: ${{ failure() }} + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + VERSION: ${{ steps.extract-version.outputs.VERSION }} + RUN_URL: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }} + run: gh issue create --title "Publishing v$VERSION to Maven Central failed" --body "See $RUN_URL" --label "failed-release" release_pypi: name: Publish to PyPI needs: release diff --git a/.projen/tasks.json b/.projen/tasks.json index 741bdbc7c..2aa313895 100644 --- a/.projen/tasks.json +++ b/.projen/tasks.json @@ -114,7 +114,7 @@ "description": "Generate documentation for the project", "steps": [ { - "exec": "rm -rf docs && rm -f API.md && mkdir docs && jsii-docgen --split-by-submodule -l typescript -l python -l go && mv *.*.md docs && cd docs && ls ./ | xargs sed -i '150000,$ d' $1" + "exec": "rm -rf docs && rm -f API.md && mkdir docs && jsii-docgen --split-by-submodule -l typescript -l python -l java -l csharp -l go && mv *.*.md docs && cd docs && ls ./ | xargs sed -i '150000,$ d' $1" } ] }, @@ -183,6 +183,9 @@ { "spawn": "package:js" }, + { + "spawn": "package:java" + }, { "spawn": "package:python" }, @@ -212,6 +215,15 @@ } ] }, + "package:java": { + "name": "package:java", + "description": "Create java language bindings", + "steps": [ + { + "exec": "jsii-pacmak -v --target java" + } + ] + }, "package:js": { "name": "package:js", "description": "Create js language bindings", diff --git a/package.json b/package.json index 349af1bdf..d4b12d70e 100644 --- a/package.json +++ b/package.json @@ -20,6 +20,7 @@ "package-all": "projen package-all", "package:dotnet": "projen package:dotnet", "package:go": "projen package:go", + "package:java": "projen package:java", "package:js": "projen package:js", "package:python": "projen package:python", "post-compile": "projen post-compile", @@ -95,6 +96,13 @@ "jsii": { "outdir": "dist", "targets": { + "java": { + "package": "io.cdktn.providers.github", + "maven": { + "groupId": "io.cdktn", + "artifactId": "cdktn-provider-github" + } + }, "python": { "distName": "cdktn-provider-github", "module": "cdktn_provider_github" diff --git a/yarn.lock b/yarn.lock index f31a26ca1..e09fabcd8 100644 --- a/yarn.lock +++ b/yarn.lock @@ -219,9 +219,9 @@ jsii-pacmak "1.128.0" "@cdktn/provider-project@^0.7.0": - version "0.7.37" - resolved "https://registry.yarnpkg.com/@cdktn/provider-project/-/provider-project-0.7.37.tgz#465270cd770a61f7fc8168e72d6eba69d1135afb" - integrity sha512-Ilico1fWA5tj1NMtfmITYsgAdlIGVNOoRyHCGqt1HUHg9yjFO4nryaSV4IdwHgZSVgbAlpDWZOzIVgfV5H8htg== + version "0.7.38" + resolved "https://registry.yarnpkg.com/@cdktn/provider-project/-/provider-project-0.7.38.tgz#d4a45f6556f12dda443964b5e4b27b538e0c060d" + integrity sha512-e4QyaWpFW1CufCG3X5j5xbeT67d/mJSNec9uZewQzzjmo2IZqU6bnjTpNl1nCDUIe3kpJWCCKvprqYyhz+A58Q== dependencies: change-case "^4.1.2" fs-extra "^10.1.0" From 5daa1886ca52aae93fbe45190385e18775448c8a Mon Sep 17 00:00:00 2001 From: team-cdk-terrain Date: Fri, 8 May 2026 15:30:54 +0000 Subject: [PATCH 2/2] chore: self mutation Signed-off-by: team-cdk-terrain --- docs/API.csharp.md | 175 + docs/API.java.md | 175 + docs/actionsEnvironmentSecret.csharp.md | 1219 ++ docs/actionsEnvironmentSecret.java.md | 1380 ++ docs/actionsEnvironmentVariable.csharp.md | 1021 ++ docs/actionsEnvironmentVariable.java.md | 1134 ++ docs/actionsHostedRunner.csharp.md | 2871 ++++ docs/actionsHostedRunner.java.md | 3031 ++++ ...ubjectClaimCustomizationTemplate.csharp.md | 874 + ...cSubjectClaimCustomizationTemplate.java.md | 951 ++ docs/actionsOrganizationPermissions.csharp.md | 1789 ++ docs/actionsOrganizationPermissions.java.md | 1918 +++ docs/actionsOrganizationSecret.csharp.md | 1258 ++ docs/actionsOrganizationSecret.java.md | 1429 ++ ...nsOrganizationSecretRepositories.csharp.md | 912 + ...ionsOrganizationSecretRepositories.java.md | 1001 ++ ...ionsOrganizationSecretRepository.csharp.md | 912 + ...ctionsOrganizationSecretRepository.java.md | 1001 ++ docs/actionsOrganizationVariable.csharp.md | 1019 ++ docs/actionsOrganizationVariable.java.md | 1134 ++ ...OrganizationVariableRepositories.csharp.md | 912 + ...nsOrganizationVariableRepositories.java.md | 1001 ++ ...nsOrganizationVariableRepository.csharp.md | 912 + ...ionsOrganizationVariableRepository.java.md | 1001 ++ ...sOrganizationWorkflowPermissions.csharp.md | 966 ++ ...onsOrganizationWorkflowPermissions.java.md | 1069 ++ docs/actionsRepositoryAccessLevel.csharp.md | 914 + docs/actionsRepositoryAccessLevel.java.md | 1005 ++ ...ubjectClaimCustomizationTemplate.csharp.md | 957 ++ ...cSubjectClaimCustomizationTemplate.java.md | 1058 ++ docs/actionsRepositoryPermissions.csharp.md | 1469 ++ docs/actionsRepositoryPermissions.java.md | 1596 ++ docs/actionsRunnerGroup.csharp.md | 1116 ++ docs/actionsRunnerGroup.java.md | 1244 ++ docs/actionsSecret.csharp.md | 1224 ++ docs/actionsSecret.java.md | 1383 ++ docs/actionsVariable.csharp.md | 983 ++ docs/actionsVariable.java.md | 1084 ++ docs/appInstallationRepositories.csharp.md | 912 + docs/appInstallationRepositories.java.md | 1001 ++ docs/appInstallationRepository.csharp.md | 923 + docs/appInstallationRepository.java.md | 1012 ++ docs/branch.csharp.md | 1069 ++ docs/branch.java.md | 1194 ++ docs/branchDefault.csharp.md | 1000 ++ docs/branchDefault.java.md | 1111 ++ docs/branchProtection.csharp.md | 3289 ++++ docs/branchProtection.java.md | 3512 ++++ docs/branchProtectionV3.csharp.md | 3167 ++++ docs/branchProtectionV3.java.md | 3328 ++++ docs/codespacesOrganizationSecret.csharp.md | 1071 ++ docs/codespacesOrganizationSecret.java.md | 1198 ++ ...esOrganizationSecretRepositories.csharp.md | 912 + ...acesOrganizationSecretRepositories.java.md | 1001 ++ docs/codespacesSecret.csharp.md | 1024 ++ docs/codespacesSecret.java.md | 1137 ++ docs/codespacesUserSecret.csharp.md | 1031 ++ docs/codespacesUserSecret.java.md | 1144 ++ ...ithubActionsEnvironmentPublicKey.csharp.md | 806 + ...aGithubActionsEnvironmentPublicKey.java.md | 889 + ...aGithubActionsEnvironmentSecrets.csharp.md | 1308 ++ ...ataGithubActionsEnvironmentSecrets.java.md | 1400 ++ ...ithubActionsEnvironmentVariables.csharp.md | 1319 ++ ...aGithubActionsEnvironmentVariables.java.md | 1411 ++ ...ubjectClaimCustomizationTemplate.csharp.md | 723 + ...cSubjectClaimCustomizationTemplate.java.md | 786 + ...thubActionsOrganizationPublicKey.csharp.md | 734 + ...GithubActionsOrganizationPublicKey.java.md | 797 + ...onsOrganizationRegistrationToken.csharp.md | 734 + ...tionsOrganizationRegistrationToken.java.md | 797 + ...GithubActionsOrganizationSecrets.csharp.md | 1197 ++ ...taGithubActionsOrganizationSecrets.java.md | 1259 ++ ...thubActionsOrganizationVariables.csharp.md | 1208 ++ ...GithubActionsOrganizationVariables.java.md | 1270 ++ docs/dataGithubActionsPublicKey.csharp.md | 770 + docs/dataGithubActionsPublicKey.java.md | 843 + ...taGithubActionsRegistrationToken.csharp.md | 770 + ...dataGithubActionsRegistrationToken.java.md | 843 + ...ubjectClaimCustomizationTemplate.csharp.md | 770 + ...cSubjectClaimCustomizationTemplate.java.md | 843 + docs/dataGithubActionsSecrets.csharp.md | 1272 ++ docs/dataGithubActionsSecrets.java.md | 1354 ++ docs/dataGithubActionsVariables.csharp.md | 1283 ++ docs/dataGithubActionsVariables.java.md | 1365 ++ docs/dataGithubApp.csharp.md | 781 + docs/dataGithubApp.java.md | 854 + docs/dataGithubAppToken.csharp.md | 837 + docs/dataGithubAppToken.java.md | 936 ++ docs/dataGithubBranch.csharp.md | 817 + docs/dataGithubBranch.java.md | 900 + .../dataGithubBranchProtectionRules.csharp.md | 1200 ++ docs/dataGithubBranchProtectionRules.java.md | 1272 ++ ...bCodespacesOrganizationPublicKey.csharp.md | 734 + ...hubCodespacesOrganizationPublicKey.java.md | 797 + ...hubCodespacesOrganizationSecrets.csharp.md | 1197 ++ ...ithubCodespacesOrganizationSecrets.java.md | 1259 ++ docs/dataGithubCodespacesPublicKey.csharp.md | 770 + docs/dataGithubCodespacesPublicKey.java.md | 843 + docs/dataGithubCodespacesSecrets.csharp.md | 1276 ++ docs/dataGithubCodespacesSecrets.java.md | 1362 ++ ...ataGithubCodespacesUserPublicKey.csharp.md | 734 + .../dataGithubCodespacesUserPublicKey.java.md | 797 + .../dataGithubCodespacesUserSecrets.csharp.md | 1197 ++ docs/dataGithubCodespacesUserSecrets.java.md | 1259 ++ docs/dataGithubCollaborators.csharp.md | 1487 ++ docs/dataGithubCollaborators.java.md | 1589 ++ ...bDependabotOrganizationPublicKey.csharp.md | 734 + ...hubDependabotOrganizationPublicKey.java.md | 797 + ...hubDependabotOrganizationSecrets.csharp.md | 1197 ++ ...ithubDependabotOrganizationSecrets.java.md | 1259 ++ docs/dataGithubDependabotPublicKey.csharp.md | 770 + docs/dataGithubDependabotPublicKey.java.md | 843 + docs/dataGithubDependabotSecrets.csharp.md | 1272 ++ docs/dataGithubDependabotSecrets.java.md | 1354 ++ docs/dataGithubEnterprise.csharp.md | 803 + docs/dataGithubEnterprise.java.md | 876 + docs/dataGithubExternalGroups.csharp.md | 1186 ++ docs/dataGithubExternalGroups.java.md | 1248 ++ docs/dataGithubIpRanges.csharp.md | 1075 ++ docs/dataGithubIpRanges.java.md | 1138 ++ docs/dataGithubIssueLabels.csharp.md | 1233 ++ docs/dataGithubIssueLabels.java.md | 1305 ++ docs/dataGithubMembership.csharp.md | 824 + docs/dataGithubMembership.java.md | 907 + docs/dataGithubOrganization.csharp.md | 1120 ++ docs/dataGithubOrganization.java.md | 1213 ++ ...thubOrganizationAppInstallations.csharp.md | 1296 ++ ...GithubOrganizationAppInstallations.java.md | 1358 ++ ...thubOrganizationCustomProperties.csharp.md | 1006 ++ ...GithubOrganizationCustomProperties.java.md | 1139 ++ ...dataGithubOrganizationCustomRole.csharp.md | 781 + docs/dataGithubOrganizationCustomRole.java.md | 854 + ...ubOrganizationExternalIdentities.csharp.md | 1186 ++ ...thubOrganizationExternalIdentities.java.md | 1248 ++ ...ataGithubOrganizationIpAllowList.csharp.md | 1219 ++ .../dataGithubOrganizationIpAllowList.java.md | 1281 ++ ...GithubOrganizationRepositoryRole.csharp.md | 794 + ...taGithubOrganizationRepositoryRole.java.md | 869 + ...ithubOrganizationRepositoryRoles.csharp.md | 1208 ++ ...aGithubOrganizationRepositoryRoles.java.md | 1270 ++ docs/dataGithubOrganizationRole.csharp.md | 805 + docs/dataGithubOrganizationRole.java.md | 880 + .../dataGithubOrganizationRoleTeams.csharp.md | 1235 ++ docs/dataGithubOrganizationRoleTeams.java.md | 1309 ++ .../dataGithubOrganizationRoleUsers.csharp.md | 1213 ++ docs/dataGithubOrganizationRoleUsers.java.md | 1287 ++ docs/dataGithubOrganizationRoles.csharp.md | 1219 ++ docs/dataGithubOrganizationRoles.java.md | 1281 ++ ...thubOrganizationSecurityManagers.csharp.md | 1197 ++ ...GithubOrganizationSecurityManagers.java.md | 1259 ++ ...GithubOrganizationTeamSyncGroups.csharp.md | 1186 ++ ...taGithubOrganizationTeamSyncGroups.java.md | 1248 ++ docs/dataGithubOrganizationTeams.csharp.md | 1403 ++ docs/dataGithubOrganizationTeams.java.md | 1495 ++ docs/dataGithubOrganizationWebhooks.csharp.md | 1208 ++ docs/dataGithubOrganizationWebhooks.java.md | 1270 ++ docs/dataGithubRef.csharp.md | 849 + docs/dataGithubRef.java.md | 942 ++ docs/dataGithubRelease.csharp.md | 1621 ++ docs/dataGithubRelease.java.md | 1743 ++ docs/dataGithubReleaseAsset.csharp.md | 981 ++ docs/dataGithubReleaseAsset.java.md | 1092 ++ docs/dataGithubRepositories.csharp.md | 910 + docs/dataGithubRepositories.java.md | 1013 ++ docs/dataGithubRepository.csharp.md | 3789 +++++ docs/dataGithubRepository.java.md | 3887 +++++ ...thubRepositoryAutolinkReferences.csharp.md | 1222 ++ ...GithubRepositoryAutolinkReferences.java.md | 1294 ++ docs/dataGithubRepositoryBranches.csharp.md | 1297 ++ docs/dataGithubRepositoryBranches.java.md | 1389 ++ ...GithubRepositoryCustomProperties.csharp.md | 1213 ++ ...taGithubRepositoryCustomProperties.java.md | 1287 ++ docs/dataGithubRepositoryDeployKeys.csharp.md | 1233 ++ docs/dataGithubRepositoryDeployKeys.java.md | 1305 ++ ...positoryDeploymentBranchPolicies.csharp.md | 1251 ++ ...RepositoryDeploymentBranchPolicies.java.md | 1337 ++ ...oryEnvironmentDeploymentPolicies.csharp.md | 1251 ++ ...itoryEnvironmentDeploymentPolicies.java.md | 1337 ++ ...dataGithubRepositoryEnvironments.csharp.md | 1211 ++ docs/dataGithubRepositoryEnvironments.java.md | 1283 ++ docs/dataGithubRepositoryFile.csharp.md | 910 + docs/dataGithubRepositoryFile.java.md | 1009 ++ docs/dataGithubRepositoryMilestone.csharp.md | 864 + docs/dataGithubRepositoryMilestone.java.md | 957 ++ docs/dataGithubRepositoryPages.csharp.md | 1301 ++ docs/dataGithubRepositoryPages.java.md | 1375 ++ .../dataGithubRepositoryPullRequest.csharp.md | 992 ++ docs/dataGithubRepositoryPullRequest.java.md | 1085 ++ ...dataGithubRepositoryPullRequests.csharp.md | 1623 ++ docs/dataGithubRepositoryPullRequests.java.md | 1755 ++ docs/dataGithubRepositoryTeams.csharp.md | 1272 ++ docs/dataGithubRepositoryTeams.java.md | 1354 ++ docs/dataGithubRepositoryWebhooks.csharp.md | 1244 ++ docs/dataGithubRepositoryWebhooks.java.md | 1316 ++ docs/dataGithubRestApi.csharp.md | 792 + docs/dataGithubRestApi.java.md | 865 + docs/dataGithubSshKeys.csharp.md | 723 + docs/dataGithubSshKeys.java.md | 786 + docs/dataGithubTeam.csharp.md | 1439 ++ docs/dataGithubTeam.java.md | 1541 ++ docs/dataGithubTree.csharp.md | 1323 ++ docs/dataGithubTree.java.md | 1415 ++ docs/dataGithubUser.csharp.md | 968 ++ docs/dataGithubUser.java.md | 1041 ++ docs/dataGithubUserExternalIdentity.csharp.md | 781 + docs/dataGithubUserExternalIdentity.java.md | 854 + docs/dataGithubUsers.csharp.md | 792 + docs/dataGithubUsers.java.md | 865 + docs/dependabotOrganizationSecret.csharp.md | 1217 ++ docs/dependabotOrganizationSecret.java.md | 1380 ++ ...otOrganizationSecretRepositories.csharp.md | 912 + ...abotOrganizationSecretRepositories.java.md | 1001 ++ ...abotOrganizationSecretRepository.csharp.md | 912 + ...ndabotOrganizationSecretRepository.java.md | 1001 ++ docs/dependabotSecret.csharp.md | 1181 ++ docs/dependabotSecret.java.md | 1330 ++ docs/emuGroupMapping.csharp.md | 945 ++ docs/emuGroupMapping.java.md | 1034 ++ docs/enterpriseActionsPermissions.csharp.md | 1782 ++ docs/enterpriseActionsPermissions.java.md | 1911 +++ docs/enterpriseActionsRunnerGroup.csharp.md | 1178 ++ docs/enterpriseActionsRunnerGroup.java.md | 1331 ++ ...rpriseActionsWorkflowPermissions.csharp.md | 964 ++ ...terpriseActionsWorkflowPermissions.java.md | 1065 ++ docs/enterpriseIpAllowListEntry.csharp.md | 1024 ++ docs/enterpriseIpAllowListEntry.java.md | 1137 ++ docs/enterpriseOrganization.csharp.md | 1054 ++ docs/enterpriseOrganization.java.md | 1178 ++ ...terpriseSecurityAnalysisSettings.csharp.md | 1099 ++ ...enterpriseSecurityAnalysisSettings.java.md | 1236 ++ docs/issue.csharp.md | 1125 ++ docs/issue.java.md | 1262 ++ docs/issueLabel.csharp.md | 1049 ++ docs/issueLabel.java.md | 1172 ++ docs/issueLabels.csharp.md | 1510 ++ docs/issueLabels.java.md | 1599 ++ docs/membership.csharp.md | 977 ++ docs/membership.java.md | 1080 ++ docs/organizationBlock.csharp.md | 885 + docs/organizationBlock.java.md | 962 ++ docs/organizationCustomProperties.csharp.md | 1146 ++ docs/organizationCustomProperties.java.md | 1297 ++ docs/organizationCustomRole.csharp.md | 995 ++ docs/organizationCustomRole.java.md | 1108 ++ docs/organizationProject.csharp.md | 941 ++ docs/organizationProject.java.md | 1030 ++ docs/organizationRepositoryRole.csharp.md | 1006 ++ docs/organizationRepositoryRole.java.md | 1119 ++ docs/organizationRole.csharp.md | 1013 ++ docs/organizationRole.java.md | 1126 ++ docs/organizationRoleTeam.csharp.md | 912 + docs/organizationRoleTeam.java.md | 1001 ++ docs/organizationRoleTeamAssignment.csharp.md | 912 + docs/organizationRoleTeamAssignment.java.md | 1001 ++ docs/organizationRoleUser.csharp.md | 912 + docs/organizationRoleUser.java.md | 1001 ++ docs/organizationRuleset.csharp.md | 13829 +++++++++++++++ docs/organizationRuleset.java.md | 13968 ++++++++++++++++ docs/organizationSecurityManager.csharp.md | 874 + docs/organizationSecurityManager.java.md | 951 ++ docs/organizationSettings.csharp.md | 1999 +++ docs/organizationSettings.java.md | 2376 +++ docs/organizationWebhook.csharp.md | 1440 ++ docs/organizationWebhook.java.md | 1541 ++ docs/projectCard.csharp.md | 1031 ++ docs/projectCard.java.md | 1144 ++ docs/projectColumn.csharp.md | 934 ++ docs/projectColumn.java.md | 1023 ++ docs/provider.csharp.md | 1115 ++ docs/provider.java.md | 1287 ++ docs/release.csharp.md | 1352 ++ docs/release.java.md | 1529 ++ docs/repository.csharp.md | 6379 +++++++ docs/repository.java.md | 6914 ++++++++ docs/repositoryAutolinkReference.csharp.md | 1008 ++ docs/repositoryAutolinkReference.java.md | 1123 ++ docs/repositoryCollaborator.csharp.md | 1015 ++ docs/repositoryCollaborator.java.md | 1130 ++ docs/repositoryCollaborators.csharp.md | 2606 +++ docs/repositoryCollaborators.java.md | 2719 +++ docs/repositoryCustomProperty.csharp.md | 988 ++ docs/repositoryCustomProperty.java.md | 1101 ++ ...ositoryDependabotSecurityUpdates.csharp.md | 912 + ...epositoryDependabotSecurityUpdates.java.md | 1001 ++ docs/repositoryDeployKey.csharp.md | 1006 ++ docs/repositoryDeployKey.java.md | 1119 ++ ...repositoryDeploymentBranchPolicy.csharp.md | 995 ++ docs/repositoryDeploymentBranchPolicy.java.md | 1108 ++ docs/repositoryEnvironment.csharp.md | 1879 +++ docs/repositoryEnvironment.java.md | 2028 +++ ...itoryEnvironmentDeploymentPolicy.csharp.md | 1024 ++ ...ositoryEnvironmentDeploymentPolicy.java.md | 1137 ++ docs/repositoryFile.csharp.md | 1362 ++ docs/repositoryFile.java.md | 1567 ++ docs/repositoryMilestone.csharp.md | 1096 ++ docs/repositoryMilestone.java.md | 1233 ++ docs/repositoryPages.csharp.md | 1520 ++ docs/repositoryPages.java.md | 1659 ++ docs/repositoryProject.csharp.md | 1011 ++ docs/repositoryProject.java.md | 1122 ++ docs/repositoryPullRequest.csharp.md | 1222 ++ docs/repositoryPullRequest.java.md | 1371 ++ docs/repositoryRuleset.csharp.md | 11847 +++++++++++++ docs/repositoryRuleset.java.md | 11996 +++++++++++++ docs/repositoryTopics.csharp.md | 914 + docs/repositoryTopics.java.md | 1005 ++ docs/repositoryVulnerabilityAlerts.csharp.md | 930 + docs/repositoryVulnerabilityAlerts.java.md | 1019 ++ docs/repositoryWebhook.csharp.md | 1510 ++ docs/repositoryWebhook.java.md | 1633 ++ docs/team.csharp.md | 1278 ++ docs/team.java.md | 1451 ++ docs/teamMembers.csharp.md | 1454 ++ docs/teamMembers.java.md | 1543 ++ docs/teamMembership.csharp.md | 968 ++ docs/teamMembership.java.md | 1069 ++ docs/teamRepository.csharp.md | 970 ++ docs/teamRepository.java.md | 1073 ++ docs/teamSettings.csharp.md | 1402 ++ docs/teamSettings.java.md | 1503 ++ docs/teamSyncGroupMapping.csharp.md | 1503 ++ docs/teamSyncGroupMapping.java.md | 1592 ++ docs/userGpgKey.csharp.md | 896 + docs/userGpgKey.java.md | 973 ++ docs/userInvitationAccepter.csharp.md | 928 + docs/userInvitationAccepter.java.md | 1019 ++ docs/userSshKey.csharp.md | 934 ++ docs/userSshKey.java.md | 1023 ++ docs/workflowRepositoryPermissions.csharp.md | 964 ++ docs/workflowRepositoryPermissions.java.md | 1065 ++ 330 files changed, 452143 insertions(+) create mode 100644 docs/API.csharp.md create mode 100644 docs/API.java.md create mode 100644 docs/actionsEnvironmentSecret.csharp.md create mode 100644 docs/actionsEnvironmentSecret.java.md create mode 100644 docs/actionsEnvironmentVariable.csharp.md create mode 100644 docs/actionsEnvironmentVariable.java.md create mode 100644 docs/actionsHostedRunner.csharp.md create mode 100644 docs/actionsHostedRunner.java.md create mode 100644 docs/actionsOrganizationOidcSubjectClaimCustomizationTemplate.csharp.md create mode 100644 docs/actionsOrganizationOidcSubjectClaimCustomizationTemplate.java.md create mode 100644 docs/actionsOrganizationPermissions.csharp.md create mode 100644 docs/actionsOrganizationPermissions.java.md create mode 100644 docs/actionsOrganizationSecret.csharp.md create mode 100644 docs/actionsOrganizationSecret.java.md create mode 100644 docs/actionsOrganizationSecretRepositories.csharp.md create mode 100644 docs/actionsOrganizationSecretRepositories.java.md create mode 100644 docs/actionsOrganizationSecretRepository.csharp.md create mode 100644 docs/actionsOrganizationSecretRepository.java.md create mode 100644 docs/actionsOrganizationVariable.csharp.md create mode 100644 docs/actionsOrganizationVariable.java.md create mode 100644 docs/actionsOrganizationVariableRepositories.csharp.md create mode 100644 docs/actionsOrganizationVariableRepositories.java.md create mode 100644 docs/actionsOrganizationVariableRepository.csharp.md create mode 100644 docs/actionsOrganizationVariableRepository.java.md create mode 100644 docs/actionsOrganizationWorkflowPermissions.csharp.md create mode 100644 docs/actionsOrganizationWorkflowPermissions.java.md create mode 100644 docs/actionsRepositoryAccessLevel.csharp.md create mode 100644 docs/actionsRepositoryAccessLevel.java.md create mode 100644 docs/actionsRepositoryOidcSubjectClaimCustomizationTemplate.csharp.md create mode 100644 docs/actionsRepositoryOidcSubjectClaimCustomizationTemplate.java.md create mode 100644 docs/actionsRepositoryPermissions.csharp.md create mode 100644 docs/actionsRepositoryPermissions.java.md create mode 100644 docs/actionsRunnerGroup.csharp.md create mode 100644 docs/actionsRunnerGroup.java.md create mode 100644 docs/actionsSecret.csharp.md create mode 100644 docs/actionsSecret.java.md create mode 100644 docs/actionsVariable.csharp.md create mode 100644 docs/actionsVariable.java.md create mode 100644 docs/appInstallationRepositories.csharp.md create mode 100644 docs/appInstallationRepositories.java.md create mode 100644 docs/appInstallationRepository.csharp.md create mode 100644 docs/appInstallationRepository.java.md create mode 100644 docs/branch.csharp.md create mode 100644 docs/branch.java.md create mode 100644 docs/branchDefault.csharp.md create mode 100644 docs/branchDefault.java.md create mode 100644 docs/branchProtection.csharp.md create mode 100644 docs/branchProtection.java.md create mode 100644 docs/branchProtectionV3.csharp.md create mode 100644 docs/branchProtectionV3.java.md create mode 100644 docs/codespacesOrganizationSecret.csharp.md create mode 100644 docs/codespacesOrganizationSecret.java.md create mode 100644 docs/codespacesOrganizationSecretRepositories.csharp.md create mode 100644 docs/codespacesOrganizationSecretRepositories.java.md create mode 100644 docs/codespacesSecret.csharp.md create mode 100644 docs/codespacesSecret.java.md create mode 100644 docs/codespacesUserSecret.csharp.md create mode 100644 docs/codespacesUserSecret.java.md create mode 100644 docs/dataGithubActionsEnvironmentPublicKey.csharp.md create mode 100644 docs/dataGithubActionsEnvironmentPublicKey.java.md create mode 100644 docs/dataGithubActionsEnvironmentSecrets.csharp.md create mode 100644 docs/dataGithubActionsEnvironmentSecrets.java.md create mode 100644 docs/dataGithubActionsEnvironmentVariables.csharp.md create mode 100644 docs/dataGithubActionsEnvironmentVariables.java.md create mode 100644 docs/dataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate.csharp.md create mode 100644 docs/dataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate.java.md create mode 100644 docs/dataGithubActionsOrganizationPublicKey.csharp.md create mode 100644 docs/dataGithubActionsOrganizationPublicKey.java.md create mode 100644 docs/dataGithubActionsOrganizationRegistrationToken.csharp.md create mode 100644 docs/dataGithubActionsOrganizationRegistrationToken.java.md create mode 100644 docs/dataGithubActionsOrganizationSecrets.csharp.md create mode 100644 docs/dataGithubActionsOrganizationSecrets.java.md create mode 100644 docs/dataGithubActionsOrganizationVariables.csharp.md create mode 100644 docs/dataGithubActionsOrganizationVariables.java.md create mode 100644 docs/dataGithubActionsPublicKey.csharp.md create mode 100644 docs/dataGithubActionsPublicKey.java.md create mode 100644 docs/dataGithubActionsRegistrationToken.csharp.md create mode 100644 docs/dataGithubActionsRegistrationToken.java.md create mode 100644 docs/dataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate.csharp.md create mode 100644 docs/dataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate.java.md create mode 100644 docs/dataGithubActionsSecrets.csharp.md create mode 100644 docs/dataGithubActionsSecrets.java.md create mode 100644 docs/dataGithubActionsVariables.csharp.md create mode 100644 docs/dataGithubActionsVariables.java.md create mode 100644 docs/dataGithubApp.csharp.md create mode 100644 docs/dataGithubApp.java.md create mode 100644 docs/dataGithubAppToken.csharp.md create mode 100644 docs/dataGithubAppToken.java.md create mode 100644 docs/dataGithubBranch.csharp.md create mode 100644 docs/dataGithubBranch.java.md create mode 100644 docs/dataGithubBranchProtectionRules.csharp.md create mode 100644 docs/dataGithubBranchProtectionRules.java.md create mode 100644 docs/dataGithubCodespacesOrganizationPublicKey.csharp.md create mode 100644 docs/dataGithubCodespacesOrganizationPublicKey.java.md create mode 100644 docs/dataGithubCodespacesOrganizationSecrets.csharp.md create mode 100644 docs/dataGithubCodespacesOrganizationSecrets.java.md create mode 100644 docs/dataGithubCodespacesPublicKey.csharp.md create mode 100644 docs/dataGithubCodespacesPublicKey.java.md create mode 100644 docs/dataGithubCodespacesSecrets.csharp.md create mode 100644 docs/dataGithubCodespacesSecrets.java.md create mode 100644 docs/dataGithubCodespacesUserPublicKey.csharp.md create mode 100644 docs/dataGithubCodespacesUserPublicKey.java.md create mode 100644 docs/dataGithubCodespacesUserSecrets.csharp.md create mode 100644 docs/dataGithubCodespacesUserSecrets.java.md create mode 100644 docs/dataGithubCollaborators.csharp.md create mode 100644 docs/dataGithubCollaborators.java.md create mode 100644 docs/dataGithubDependabotOrganizationPublicKey.csharp.md create mode 100644 docs/dataGithubDependabotOrganizationPublicKey.java.md create mode 100644 docs/dataGithubDependabotOrganizationSecrets.csharp.md create mode 100644 docs/dataGithubDependabotOrganizationSecrets.java.md create mode 100644 docs/dataGithubDependabotPublicKey.csharp.md create mode 100644 docs/dataGithubDependabotPublicKey.java.md create mode 100644 docs/dataGithubDependabotSecrets.csharp.md create mode 100644 docs/dataGithubDependabotSecrets.java.md create mode 100644 docs/dataGithubEnterprise.csharp.md create mode 100644 docs/dataGithubEnterprise.java.md create mode 100644 docs/dataGithubExternalGroups.csharp.md create mode 100644 docs/dataGithubExternalGroups.java.md create mode 100644 docs/dataGithubIpRanges.csharp.md create mode 100644 docs/dataGithubIpRanges.java.md create mode 100644 docs/dataGithubIssueLabels.csharp.md create mode 100644 docs/dataGithubIssueLabels.java.md create mode 100644 docs/dataGithubMembership.csharp.md create mode 100644 docs/dataGithubMembership.java.md create mode 100644 docs/dataGithubOrganization.csharp.md create mode 100644 docs/dataGithubOrganization.java.md create mode 100644 docs/dataGithubOrganizationAppInstallations.csharp.md create mode 100644 docs/dataGithubOrganizationAppInstallations.java.md create mode 100644 docs/dataGithubOrganizationCustomProperties.csharp.md create mode 100644 docs/dataGithubOrganizationCustomProperties.java.md create mode 100644 docs/dataGithubOrganizationCustomRole.csharp.md create mode 100644 docs/dataGithubOrganizationCustomRole.java.md create mode 100644 docs/dataGithubOrganizationExternalIdentities.csharp.md create mode 100644 docs/dataGithubOrganizationExternalIdentities.java.md create mode 100644 docs/dataGithubOrganizationIpAllowList.csharp.md create mode 100644 docs/dataGithubOrganizationIpAllowList.java.md create mode 100644 docs/dataGithubOrganizationRepositoryRole.csharp.md create mode 100644 docs/dataGithubOrganizationRepositoryRole.java.md create mode 100644 docs/dataGithubOrganizationRepositoryRoles.csharp.md create mode 100644 docs/dataGithubOrganizationRepositoryRoles.java.md create mode 100644 docs/dataGithubOrganizationRole.csharp.md create mode 100644 docs/dataGithubOrganizationRole.java.md create mode 100644 docs/dataGithubOrganizationRoleTeams.csharp.md create mode 100644 docs/dataGithubOrganizationRoleTeams.java.md create mode 100644 docs/dataGithubOrganizationRoleUsers.csharp.md create mode 100644 docs/dataGithubOrganizationRoleUsers.java.md create mode 100644 docs/dataGithubOrganizationRoles.csharp.md create mode 100644 docs/dataGithubOrganizationRoles.java.md create mode 100644 docs/dataGithubOrganizationSecurityManagers.csharp.md create mode 100644 docs/dataGithubOrganizationSecurityManagers.java.md create mode 100644 docs/dataGithubOrganizationTeamSyncGroups.csharp.md create mode 100644 docs/dataGithubOrganizationTeamSyncGroups.java.md create mode 100644 docs/dataGithubOrganizationTeams.csharp.md create mode 100644 docs/dataGithubOrganizationTeams.java.md create mode 100644 docs/dataGithubOrganizationWebhooks.csharp.md create mode 100644 docs/dataGithubOrganizationWebhooks.java.md create mode 100644 docs/dataGithubRef.csharp.md create mode 100644 docs/dataGithubRef.java.md create mode 100644 docs/dataGithubRelease.csharp.md create mode 100644 docs/dataGithubRelease.java.md create mode 100644 docs/dataGithubReleaseAsset.csharp.md create mode 100644 docs/dataGithubReleaseAsset.java.md create mode 100644 docs/dataGithubRepositories.csharp.md create mode 100644 docs/dataGithubRepositories.java.md create mode 100644 docs/dataGithubRepository.csharp.md create mode 100644 docs/dataGithubRepository.java.md create mode 100644 docs/dataGithubRepositoryAutolinkReferences.csharp.md create mode 100644 docs/dataGithubRepositoryAutolinkReferences.java.md create mode 100644 docs/dataGithubRepositoryBranches.csharp.md create mode 100644 docs/dataGithubRepositoryBranches.java.md create mode 100644 docs/dataGithubRepositoryCustomProperties.csharp.md create mode 100644 docs/dataGithubRepositoryCustomProperties.java.md create mode 100644 docs/dataGithubRepositoryDeployKeys.csharp.md create mode 100644 docs/dataGithubRepositoryDeployKeys.java.md create mode 100644 docs/dataGithubRepositoryDeploymentBranchPolicies.csharp.md create mode 100644 docs/dataGithubRepositoryDeploymentBranchPolicies.java.md create mode 100644 docs/dataGithubRepositoryEnvironmentDeploymentPolicies.csharp.md create mode 100644 docs/dataGithubRepositoryEnvironmentDeploymentPolicies.java.md create mode 100644 docs/dataGithubRepositoryEnvironments.csharp.md create mode 100644 docs/dataGithubRepositoryEnvironments.java.md create mode 100644 docs/dataGithubRepositoryFile.csharp.md create mode 100644 docs/dataGithubRepositoryFile.java.md create mode 100644 docs/dataGithubRepositoryMilestone.csharp.md create mode 100644 docs/dataGithubRepositoryMilestone.java.md create mode 100644 docs/dataGithubRepositoryPages.csharp.md create mode 100644 docs/dataGithubRepositoryPages.java.md create mode 100644 docs/dataGithubRepositoryPullRequest.csharp.md create mode 100644 docs/dataGithubRepositoryPullRequest.java.md create mode 100644 docs/dataGithubRepositoryPullRequests.csharp.md create mode 100644 docs/dataGithubRepositoryPullRequests.java.md create mode 100644 docs/dataGithubRepositoryTeams.csharp.md create mode 100644 docs/dataGithubRepositoryTeams.java.md create mode 100644 docs/dataGithubRepositoryWebhooks.csharp.md create mode 100644 docs/dataGithubRepositoryWebhooks.java.md create mode 100644 docs/dataGithubRestApi.csharp.md create mode 100644 docs/dataGithubRestApi.java.md create mode 100644 docs/dataGithubSshKeys.csharp.md create mode 100644 docs/dataGithubSshKeys.java.md create mode 100644 docs/dataGithubTeam.csharp.md create mode 100644 docs/dataGithubTeam.java.md create mode 100644 docs/dataGithubTree.csharp.md create mode 100644 docs/dataGithubTree.java.md create mode 100644 docs/dataGithubUser.csharp.md create mode 100644 docs/dataGithubUser.java.md create mode 100644 docs/dataGithubUserExternalIdentity.csharp.md create mode 100644 docs/dataGithubUserExternalIdentity.java.md create mode 100644 docs/dataGithubUsers.csharp.md create mode 100644 docs/dataGithubUsers.java.md create mode 100644 docs/dependabotOrganizationSecret.csharp.md create mode 100644 docs/dependabotOrganizationSecret.java.md create mode 100644 docs/dependabotOrganizationSecretRepositories.csharp.md create mode 100644 docs/dependabotOrganizationSecretRepositories.java.md create mode 100644 docs/dependabotOrganizationSecretRepository.csharp.md create mode 100644 docs/dependabotOrganizationSecretRepository.java.md create mode 100644 docs/dependabotSecret.csharp.md create mode 100644 docs/dependabotSecret.java.md create mode 100644 docs/emuGroupMapping.csharp.md create mode 100644 docs/emuGroupMapping.java.md create mode 100644 docs/enterpriseActionsPermissions.csharp.md create mode 100644 docs/enterpriseActionsPermissions.java.md create mode 100644 docs/enterpriseActionsRunnerGroup.csharp.md create mode 100644 docs/enterpriseActionsRunnerGroup.java.md create mode 100644 docs/enterpriseActionsWorkflowPermissions.csharp.md create mode 100644 docs/enterpriseActionsWorkflowPermissions.java.md create mode 100644 docs/enterpriseIpAllowListEntry.csharp.md create mode 100644 docs/enterpriseIpAllowListEntry.java.md create mode 100644 docs/enterpriseOrganization.csharp.md create mode 100644 docs/enterpriseOrganization.java.md create mode 100644 docs/enterpriseSecurityAnalysisSettings.csharp.md create mode 100644 docs/enterpriseSecurityAnalysisSettings.java.md create mode 100644 docs/issue.csharp.md create mode 100644 docs/issue.java.md create mode 100644 docs/issueLabel.csharp.md create mode 100644 docs/issueLabel.java.md create mode 100644 docs/issueLabels.csharp.md create mode 100644 docs/issueLabels.java.md create mode 100644 docs/membership.csharp.md create mode 100644 docs/membership.java.md create mode 100644 docs/organizationBlock.csharp.md create mode 100644 docs/organizationBlock.java.md create mode 100644 docs/organizationCustomProperties.csharp.md create mode 100644 docs/organizationCustomProperties.java.md create mode 100644 docs/organizationCustomRole.csharp.md create mode 100644 docs/organizationCustomRole.java.md create mode 100644 docs/organizationProject.csharp.md create mode 100644 docs/organizationProject.java.md create mode 100644 docs/organizationRepositoryRole.csharp.md create mode 100644 docs/organizationRepositoryRole.java.md create mode 100644 docs/organizationRole.csharp.md create mode 100644 docs/organizationRole.java.md create mode 100644 docs/organizationRoleTeam.csharp.md create mode 100644 docs/organizationRoleTeam.java.md create mode 100644 docs/organizationRoleTeamAssignment.csharp.md create mode 100644 docs/organizationRoleTeamAssignment.java.md create mode 100644 docs/organizationRoleUser.csharp.md create mode 100644 docs/organizationRoleUser.java.md create mode 100644 docs/organizationRuleset.csharp.md create mode 100644 docs/organizationRuleset.java.md create mode 100644 docs/organizationSecurityManager.csharp.md create mode 100644 docs/organizationSecurityManager.java.md create mode 100644 docs/organizationSettings.csharp.md create mode 100644 docs/organizationSettings.java.md create mode 100644 docs/organizationWebhook.csharp.md create mode 100644 docs/organizationWebhook.java.md create mode 100644 docs/projectCard.csharp.md create mode 100644 docs/projectCard.java.md create mode 100644 docs/projectColumn.csharp.md create mode 100644 docs/projectColumn.java.md create mode 100644 docs/provider.csharp.md create mode 100644 docs/provider.java.md create mode 100644 docs/release.csharp.md create mode 100644 docs/release.java.md create mode 100644 docs/repository.csharp.md create mode 100644 docs/repository.java.md create mode 100644 docs/repositoryAutolinkReference.csharp.md create mode 100644 docs/repositoryAutolinkReference.java.md create mode 100644 docs/repositoryCollaborator.csharp.md create mode 100644 docs/repositoryCollaborator.java.md create mode 100644 docs/repositoryCollaborators.csharp.md create mode 100644 docs/repositoryCollaborators.java.md create mode 100644 docs/repositoryCustomProperty.csharp.md create mode 100644 docs/repositoryCustomProperty.java.md create mode 100644 docs/repositoryDependabotSecurityUpdates.csharp.md create mode 100644 docs/repositoryDependabotSecurityUpdates.java.md create mode 100644 docs/repositoryDeployKey.csharp.md create mode 100644 docs/repositoryDeployKey.java.md create mode 100644 docs/repositoryDeploymentBranchPolicy.csharp.md create mode 100644 docs/repositoryDeploymentBranchPolicy.java.md create mode 100644 docs/repositoryEnvironment.csharp.md create mode 100644 docs/repositoryEnvironment.java.md create mode 100644 docs/repositoryEnvironmentDeploymentPolicy.csharp.md create mode 100644 docs/repositoryEnvironmentDeploymentPolicy.java.md create mode 100644 docs/repositoryFile.csharp.md create mode 100644 docs/repositoryFile.java.md create mode 100644 docs/repositoryMilestone.csharp.md create mode 100644 docs/repositoryMilestone.java.md create mode 100644 docs/repositoryPages.csharp.md create mode 100644 docs/repositoryPages.java.md create mode 100644 docs/repositoryProject.csharp.md create mode 100644 docs/repositoryProject.java.md create mode 100644 docs/repositoryPullRequest.csharp.md create mode 100644 docs/repositoryPullRequest.java.md create mode 100644 docs/repositoryRuleset.csharp.md create mode 100644 docs/repositoryRuleset.java.md create mode 100644 docs/repositoryTopics.csharp.md create mode 100644 docs/repositoryTopics.java.md create mode 100644 docs/repositoryVulnerabilityAlerts.csharp.md create mode 100644 docs/repositoryVulnerabilityAlerts.java.md create mode 100644 docs/repositoryWebhook.csharp.md create mode 100644 docs/repositoryWebhook.java.md create mode 100644 docs/team.csharp.md create mode 100644 docs/team.java.md create mode 100644 docs/teamMembers.csharp.md create mode 100644 docs/teamMembers.java.md create mode 100644 docs/teamMembership.csharp.md create mode 100644 docs/teamMembership.java.md create mode 100644 docs/teamRepository.csharp.md create mode 100644 docs/teamRepository.java.md create mode 100644 docs/teamSettings.csharp.md create mode 100644 docs/teamSettings.java.md create mode 100644 docs/teamSyncGroupMapping.csharp.md create mode 100644 docs/teamSyncGroupMapping.java.md create mode 100644 docs/userGpgKey.csharp.md create mode 100644 docs/userGpgKey.java.md create mode 100644 docs/userInvitationAccepter.csharp.md create mode 100644 docs/userInvitationAccepter.java.md create mode 100644 docs/userSshKey.csharp.md create mode 100644 docs/userSshKey.java.md create mode 100644 docs/workflowRepositoryPermissions.csharp.md create mode 100644 docs/workflowRepositoryPermissions.java.md diff --git a/docs/API.csharp.md b/docs/API.csharp.md new file mode 100644 index 000000000..53eec17f0 --- /dev/null +++ b/docs/API.csharp.md @@ -0,0 +1,175 @@ +# API Reference + +## Submodules + +The following submodules are available: + +- [actionsEnvironmentSecret](./actionsEnvironmentSecret.csharp.md) +- [actionsEnvironmentVariable](./actionsEnvironmentVariable.csharp.md) +- [actionsHostedRunner](./actionsHostedRunner.csharp.md) +- [actionsOrganizationOidcSubjectClaimCustomizationTemplate](./actionsOrganizationOidcSubjectClaimCustomizationTemplate.csharp.md) +- [actionsOrganizationPermissions](./actionsOrganizationPermissions.csharp.md) +- [actionsOrganizationSecret](./actionsOrganizationSecret.csharp.md) +- [actionsOrganizationSecretRepositories](./actionsOrganizationSecretRepositories.csharp.md) +- [actionsOrganizationSecretRepository](./actionsOrganizationSecretRepository.csharp.md) +- [actionsOrganizationVariable](./actionsOrganizationVariable.csharp.md) +- [actionsOrganizationVariableRepositories](./actionsOrganizationVariableRepositories.csharp.md) +- [actionsOrganizationVariableRepository](./actionsOrganizationVariableRepository.csharp.md) +- [actionsOrganizationWorkflowPermissions](./actionsOrganizationWorkflowPermissions.csharp.md) +- [actionsRepositoryAccessLevel](./actionsRepositoryAccessLevel.csharp.md) +- [actionsRepositoryOidcSubjectClaimCustomizationTemplate](./actionsRepositoryOidcSubjectClaimCustomizationTemplate.csharp.md) +- [actionsRepositoryPermissions](./actionsRepositoryPermissions.csharp.md) +- [actionsRunnerGroup](./actionsRunnerGroup.csharp.md) +- [actionsSecret](./actionsSecret.csharp.md) +- [actionsVariable](./actionsVariable.csharp.md) +- [appInstallationRepositories](./appInstallationRepositories.csharp.md) +- [appInstallationRepository](./appInstallationRepository.csharp.md) +- [branch](./branch.csharp.md) +- [branchDefault](./branchDefault.csharp.md) +- [branchProtection](./branchProtection.csharp.md) +- [branchProtectionV3](./branchProtectionV3.csharp.md) +- [codespacesOrganizationSecret](./codespacesOrganizationSecret.csharp.md) +- [codespacesOrganizationSecretRepositories](./codespacesOrganizationSecretRepositories.csharp.md) +- [codespacesSecret](./codespacesSecret.csharp.md) +- [codespacesUserSecret](./codespacesUserSecret.csharp.md) +- [dataGithubActionsEnvironmentPublicKey](./dataGithubActionsEnvironmentPublicKey.csharp.md) +- [dataGithubActionsEnvironmentSecrets](./dataGithubActionsEnvironmentSecrets.csharp.md) +- [dataGithubActionsEnvironmentVariables](./dataGithubActionsEnvironmentVariables.csharp.md) +- [dataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate](./dataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate.csharp.md) +- [dataGithubActionsOrganizationPublicKey](./dataGithubActionsOrganizationPublicKey.csharp.md) +- [dataGithubActionsOrganizationRegistrationToken](./dataGithubActionsOrganizationRegistrationToken.csharp.md) +- [dataGithubActionsOrganizationSecrets](./dataGithubActionsOrganizationSecrets.csharp.md) +- [dataGithubActionsOrganizationVariables](./dataGithubActionsOrganizationVariables.csharp.md) +- [dataGithubActionsPublicKey](./dataGithubActionsPublicKey.csharp.md) +- [dataGithubActionsRegistrationToken](./dataGithubActionsRegistrationToken.csharp.md) +- [dataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate](./dataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate.csharp.md) +- [dataGithubActionsSecrets](./dataGithubActionsSecrets.csharp.md) +- [dataGithubActionsVariables](./dataGithubActionsVariables.csharp.md) +- [dataGithubApp](./dataGithubApp.csharp.md) +- [dataGithubAppToken](./dataGithubAppToken.csharp.md) +- [dataGithubBranch](./dataGithubBranch.csharp.md) +- [dataGithubBranchProtectionRules](./dataGithubBranchProtectionRules.csharp.md) +- [dataGithubCodespacesOrganizationPublicKey](./dataGithubCodespacesOrganizationPublicKey.csharp.md) +- [dataGithubCodespacesOrganizationSecrets](./dataGithubCodespacesOrganizationSecrets.csharp.md) +- [dataGithubCodespacesPublicKey](./dataGithubCodespacesPublicKey.csharp.md) +- [dataGithubCodespacesSecrets](./dataGithubCodespacesSecrets.csharp.md) +- [dataGithubCodespacesUserPublicKey](./dataGithubCodespacesUserPublicKey.csharp.md) +- [dataGithubCodespacesUserSecrets](./dataGithubCodespacesUserSecrets.csharp.md) +- [dataGithubCollaborators](./dataGithubCollaborators.csharp.md) +- [dataGithubDependabotOrganizationPublicKey](./dataGithubDependabotOrganizationPublicKey.csharp.md) +- [dataGithubDependabotOrganizationSecrets](./dataGithubDependabotOrganizationSecrets.csharp.md) +- [dataGithubDependabotPublicKey](./dataGithubDependabotPublicKey.csharp.md) +- [dataGithubDependabotSecrets](./dataGithubDependabotSecrets.csharp.md) +- [dataGithubEnterprise](./dataGithubEnterprise.csharp.md) +- [dataGithubExternalGroups](./dataGithubExternalGroups.csharp.md) +- [dataGithubIpRanges](./dataGithubIpRanges.csharp.md) +- [dataGithubIssueLabels](./dataGithubIssueLabels.csharp.md) +- [dataGithubMembership](./dataGithubMembership.csharp.md) +- [dataGithubOrganization](./dataGithubOrganization.csharp.md) +- [dataGithubOrganizationAppInstallations](./dataGithubOrganizationAppInstallations.csharp.md) +- [dataGithubOrganizationCustomProperties](./dataGithubOrganizationCustomProperties.csharp.md) +- [dataGithubOrganizationCustomRole](./dataGithubOrganizationCustomRole.csharp.md) +- [dataGithubOrganizationExternalIdentities](./dataGithubOrganizationExternalIdentities.csharp.md) +- [dataGithubOrganizationIpAllowList](./dataGithubOrganizationIpAllowList.csharp.md) +- [dataGithubOrganizationRepositoryRole](./dataGithubOrganizationRepositoryRole.csharp.md) +- [dataGithubOrganizationRepositoryRoles](./dataGithubOrganizationRepositoryRoles.csharp.md) +- [dataGithubOrganizationRole](./dataGithubOrganizationRole.csharp.md) +- [dataGithubOrganizationRoleTeams](./dataGithubOrganizationRoleTeams.csharp.md) +- [dataGithubOrganizationRoleUsers](./dataGithubOrganizationRoleUsers.csharp.md) +- [dataGithubOrganizationRoles](./dataGithubOrganizationRoles.csharp.md) +- [dataGithubOrganizationSecurityManagers](./dataGithubOrganizationSecurityManagers.csharp.md) +- [dataGithubOrganizationTeamSyncGroups](./dataGithubOrganizationTeamSyncGroups.csharp.md) +- [dataGithubOrganizationTeams](./dataGithubOrganizationTeams.csharp.md) +- [dataGithubOrganizationWebhooks](./dataGithubOrganizationWebhooks.csharp.md) +- [dataGithubRef](./dataGithubRef.csharp.md) +- [dataGithubRelease](./dataGithubRelease.csharp.md) +- [dataGithubReleaseAsset](./dataGithubReleaseAsset.csharp.md) +- [dataGithubRepositories](./dataGithubRepositories.csharp.md) +- [dataGithubRepository](./dataGithubRepository.csharp.md) +- [dataGithubRepositoryAutolinkReferences](./dataGithubRepositoryAutolinkReferences.csharp.md) +- [dataGithubRepositoryBranches](./dataGithubRepositoryBranches.csharp.md) +- [dataGithubRepositoryCustomProperties](./dataGithubRepositoryCustomProperties.csharp.md) +- [dataGithubRepositoryDeployKeys](./dataGithubRepositoryDeployKeys.csharp.md) +- [dataGithubRepositoryDeploymentBranchPolicies](./dataGithubRepositoryDeploymentBranchPolicies.csharp.md) +- [dataGithubRepositoryEnvironmentDeploymentPolicies](./dataGithubRepositoryEnvironmentDeploymentPolicies.csharp.md) +- [dataGithubRepositoryEnvironments](./dataGithubRepositoryEnvironments.csharp.md) +- [dataGithubRepositoryFile](./dataGithubRepositoryFile.csharp.md) +- [dataGithubRepositoryMilestone](./dataGithubRepositoryMilestone.csharp.md) +- [dataGithubRepositoryPages](./dataGithubRepositoryPages.csharp.md) +- [dataGithubRepositoryPullRequest](./dataGithubRepositoryPullRequest.csharp.md) +- [dataGithubRepositoryPullRequests](./dataGithubRepositoryPullRequests.csharp.md) +- [dataGithubRepositoryTeams](./dataGithubRepositoryTeams.csharp.md) +- [dataGithubRepositoryWebhooks](./dataGithubRepositoryWebhooks.csharp.md) +- [dataGithubRestApi](./dataGithubRestApi.csharp.md) +- [dataGithubSshKeys](./dataGithubSshKeys.csharp.md) +- [dataGithubTeam](./dataGithubTeam.csharp.md) +- [dataGithubTree](./dataGithubTree.csharp.md) +- [dataGithubUser](./dataGithubUser.csharp.md) +- [dataGithubUserExternalIdentity](./dataGithubUserExternalIdentity.csharp.md) +- [dataGithubUsers](./dataGithubUsers.csharp.md) +- [dependabotOrganizationSecret](./dependabotOrganizationSecret.csharp.md) +- [dependabotOrganizationSecretRepositories](./dependabotOrganizationSecretRepositories.csharp.md) +- [dependabotOrganizationSecretRepository](./dependabotOrganizationSecretRepository.csharp.md) +- [dependabotSecret](./dependabotSecret.csharp.md) +- [emuGroupMapping](./emuGroupMapping.csharp.md) +- [enterpriseActionsPermissions](./enterpriseActionsPermissions.csharp.md) +- [enterpriseActionsRunnerGroup](./enterpriseActionsRunnerGroup.csharp.md) +- [enterpriseActionsWorkflowPermissions](./enterpriseActionsWorkflowPermissions.csharp.md) +- [enterpriseIpAllowListEntry](./enterpriseIpAllowListEntry.csharp.md) +- [enterpriseOrganization](./enterpriseOrganization.csharp.md) +- [enterpriseSecurityAnalysisSettings](./enterpriseSecurityAnalysisSettings.csharp.md) +- [issue](./issue.csharp.md) +- [issueLabel](./issueLabel.csharp.md) +- [issueLabels](./issueLabels.csharp.md) +- [membership](./membership.csharp.md) +- [organizationBlock](./organizationBlock.csharp.md) +- [organizationCustomProperties](./organizationCustomProperties.csharp.md) +- [organizationCustomRole](./organizationCustomRole.csharp.md) +- [organizationProject](./organizationProject.csharp.md) +- [organizationRepositoryRole](./organizationRepositoryRole.csharp.md) +- [organizationRole](./organizationRole.csharp.md) +- [organizationRoleTeam](./organizationRoleTeam.csharp.md) +- [organizationRoleTeamAssignment](./organizationRoleTeamAssignment.csharp.md) +- [organizationRoleUser](./organizationRoleUser.csharp.md) +- [organizationRuleset](./organizationRuleset.csharp.md) +- [organizationSecurityManager](./organizationSecurityManager.csharp.md) +- [organizationSettings](./organizationSettings.csharp.md) +- [organizationWebhook](./organizationWebhook.csharp.md) +- [projectCard](./projectCard.csharp.md) +- [projectColumn](./projectColumn.csharp.md) +- [provider](./provider.csharp.md) +- [release](./release.csharp.md) +- [repository](./repository.csharp.md) +- [repositoryAutolinkReference](./repositoryAutolinkReference.csharp.md) +- [repositoryCollaborator](./repositoryCollaborator.csharp.md) +- [repositoryCollaborators](./repositoryCollaborators.csharp.md) +- [repositoryCustomProperty](./repositoryCustomProperty.csharp.md) +- [repositoryDependabotSecurityUpdates](./repositoryDependabotSecurityUpdates.csharp.md) +- [repositoryDeployKey](./repositoryDeployKey.csharp.md) +- [repositoryDeploymentBranchPolicy](./repositoryDeploymentBranchPolicy.csharp.md) +- [repositoryEnvironment](./repositoryEnvironment.csharp.md) +- [repositoryEnvironmentDeploymentPolicy](./repositoryEnvironmentDeploymentPolicy.csharp.md) +- [repositoryFile](./repositoryFile.csharp.md) +- [repositoryMilestone](./repositoryMilestone.csharp.md) +- [repositoryPages](./repositoryPages.csharp.md) +- [repositoryProject](./repositoryProject.csharp.md) +- [repositoryPullRequest](./repositoryPullRequest.csharp.md) +- [repositoryRuleset](./repositoryRuleset.csharp.md) +- [repositoryTopics](./repositoryTopics.csharp.md) +- [repositoryVulnerabilityAlerts](./repositoryVulnerabilityAlerts.csharp.md) +- [repositoryWebhook](./repositoryWebhook.csharp.md) +- [team](./team.csharp.md) +- [teamMembers](./teamMembers.csharp.md) +- [teamMembership](./teamMembership.csharp.md) +- [teamRepository](./teamRepository.csharp.md) +- [teamSettings](./teamSettings.csharp.md) +- [teamSyncGroupMapping](./teamSyncGroupMapping.csharp.md) +- [userGpgKey](./userGpgKey.csharp.md) +- [userInvitationAccepter](./userInvitationAccepter.csharp.md) +- [userSshKey](./userSshKey.csharp.md) +- [workflowRepositoryPermissions](./workflowRepositoryPermissions.csharp.md) + + + + + diff --git a/docs/API.java.md b/docs/API.java.md new file mode 100644 index 000000000..9b491d603 --- /dev/null +++ b/docs/API.java.md @@ -0,0 +1,175 @@ +# API Reference + +## Submodules + +The following submodules are available: + +- [actionsEnvironmentSecret](./actionsEnvironmentSecret.java.md) +- [actionsEnvironmentVariable](./actionsEnvironmentVariable.java.md) +- [actionsHostedRunner](./actionsHostedRunner.java.md) +- [actionsOrganizationOidcSubjectClaimCustomizationTemplate](./actionsOrganizationOidcSubjectClaimCustomizationTemplate.java.md) +- [actionsOrganizationPermissions](./actionsOrganizationPermissions.java.md) +- [actionsOrganizationSecret](./actionsOrganizationSecret.java.md) +- [actionsOrganizationSecretRepositories](./actionsOrganizationSecretRepositories.java.md) +- [actionsOrganizationSecretRepository](./actionsOrganizationSecretRepository.java.md) +- [actionsOrganizationVariable](./actionsOrganizationVariable.java.md) +- [actionsOrganizationVariableRepositories](./actionsOrganizationVariableRepositories.java.md) +- [actionsOrganizationVariableRepository](./actionsOrganizationVariableRepository.java.md) +- [actionsOrganizationWorkflowPermissions](./actionsOrganizationWorkflowPermissions.java.md) +- [actionsRepositoryAccessLevel](./actionsRepositoryAccessLevel.java.md) +- [actionsRepositoryOidcSubjectClaimCustomizationTemplate](./actionsRepositoryOidcSubjectClaimCustomizationTemplate.java.md) +- [actionsRepositoryPermissions](./actionsRepositoryPermissions.java.md) +- [actionsRunnerGroup](./actionsRunnerGroup.java.md) +- [actionsSecret](./actionsSecret.java.md) +- [actionsVariable](./actionsVariable.java.md) +- [appInstallationRepositories](./appInstallationRepositories.java.md) +- [appInstallationRepository](./appInstallationRepository.java.md) +- [branch](./branch.java.md) +- [branchDefault](./branchDefault.java.md) +- [branchProtection](./branchProtection.java.md) +- [branchProtectionV3](./branchProtectionV3.java.md) +- [codespacesOrganizationSecret](./codespacesOrganizationSecret.java.md) +- [codespacesOrganizationSecretRepositories](./codespacesOrganizationSecretRepositories.java.md) +- [codespacesSecret](./codespacesSecret.java.md) +- [codespacesUserSecret](./codespacesUserSecret.java.md) +- [dataGithubActionsEnvironmentPublicKey](./dataGithubActionsEnvironmentPublicKey.java.md) +- [dataGithubActionsEnvironmentSecrets](./dataGithubActionsEnvironmentSecrets.java.md) +- [dataGithubActionsEnvironmentVariables](./dataGithubActionsEnvironmentVariables.java.md) +- [dataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate](./dataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate.java.md) +- [dataGithubActionsOrganizationPublicKey](./dataGithubActionsOrganizationPublicKey.java.md) +- [dataGithubActionsOrganizationRegistrationToken](./dataGithubActionsOrganizationRegistrationToken.java.md) +- [dataGithubActionsOrganizationSecrets](./dataGithubActionsOrganizationSecrets.java.md) +- [dataGithubActionsOrganizationVariables](./dataGithubActionsOrganizationVariables.java.md) +- [dataGithubActionsPublicKey](./dataGithubActionsPublicKey.java.md) +- [dataGithubActionsRegistrationToken](./dataGithubActionsRegistrationToken.java.md) +- [dataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate](./dataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate.java.md) +- [dataGithubActionsSecrets](./dataGithubActionsSecrets.java.md) +- [dataGithubActionsVariables](./dataGithubActionsVariables.java.md) +- [dataGithubApp](./dataGithubApp.java.md) +- [dataGithubAppToken](./dataGithubAppToken.java.md) +- [dataGithubBranch](./dataGithubBranch.java.md) +- [dataGithubBranchProtectionRules](./dataGithubBranchProtectionRules.java.md) +- [dataGithubCodespacesOrganizationPublicKey](./dataGithubCodespacesOrganizationPublicKey.java.md) +- [dataGithubCodespacesOrganizationSecrets](./dataGithubCodespacesOrganizationSecrets.java.md) +- [dataGithubCodespacesPublicKey](./dataGithubCodespacesPublicKey.java.md) +- [dataGithubCodespacesSecrets](./dataGithubCodespacesSecrets.java.md) +- [dataGithubCodespacesUserPublicKey](./dataGithubCodespacesUserPublicKey.java.md) +- [dataGithubCodespacesUserSecrets](./dataGithubCodespacesUserSecrets.java.md) +- [dataGithubCollaborators](./dataGithubCollaborators.java.md) +- [dataGithubDependabotOrganizationPublicKey](./dataGithubDependabotOrganizationPublicKey.java.md) +- [dataGithubDependabotOrganizationSecrets](./dataGithubDependabotOrganizationSecrets.java.md) +- [dataGithubDependabotPublicKey](./dataGithubDependabotPublicKey.java.md) +- [dataGithubDependabotSecrets](./dataGithubDependabotSecrets.java.md) +- [dataGithubEnterprise](./dataGithubEnterprise.java.md) +- [dataGithubExternalGroups](./dataGithubExternalGroups.java.md) +- [dataGithubIpRanges](./dataGithubIpRanges.java.md) +- [dataGithubIssueLabels](./dataGithubIssueLabels.java.md) +- [dataGithubMembership](./dataGithubMembership.java.md) +- [dataGithubOrganization](./dataGithubOrganization.java.md) +- [dataGithubOrganizationAppInstallations](./dataGithubOrganizationAppInstallations.java.md) +- [dataGithubOrganizationCustomProperties](./dataGithubOrganizationCustomProperties.java.md) +- [dataGithubOrganizationCustomRole](./dataGithubOrganizationCustomRole.java.md) +- [dataGithubOrganizationExternalIdentities](./dataGithubOrganizationExternalIdentities.java.md) +- [dataGithubOrganizationIpAllowList](./dataGithubOrganizationIpAllowList.java.md) +- [dataGithubOrganizationRepositoryRole](./dataGithubOrganizationRepositoryRole.java.md) +- [dataGithubOrganizationRepositoryRoles](./dataGithubOrganizationRepositoryRoles.java.md) +- [dataGithubOrganizationRole](./dataGithubOrganizationRole.java.md) +- [dataGithubOrganizationRoleTeams](./dataGithubOrganizationRoleTeams.java.md) +- [dataGithubOrganizationRoleUsers](./dataGithubOrganizationRoleUsers.java.md) +- [dataGithubOrganizationRoles](./dataGithubOrganizationRoles.java.md) +- [dataGithubOrganizationSecurityManagers](./dataGithubOrganizationSecurityManagers.java.md) +- [dataGithubOrganizationTeamSyncGroups](./dataGithubOrganizationTeamSyncGroups.java.md) +- [dataGithubOrganizationTeams](./dataGithubOrganizationTeams.java.md) +- [dataGithubOrganizationWebhooks](./dataGithubOrganizationWebhooks.java.md) +- [dataGithubRef](./dataGithubRef.java.md) +- [dataGithubRelease](./dataGithubRelease.java.md) +- [dataGithubReleaseAsset](./dataGithubReleaseAsset.java.md) +- [dataGithubRepositories](./dataGithubRepositories.java.md) +- [dataGithubRepository](./dataGithubRepository.java.md) +- [dataGithubRepositoryAutolinkReferences](./dataGithubRepositoryAutolinkReferences.java.md) +- [dataGithubRepositoryBranches](./dataGithubRepositoryBranches.java.md) +- [dataGithubRepositoryCustomProperties](./dataGithubRepositoryCustomProperties.java.md) +- [dataGithubRepositoryDeployKeys](./dataGithubRepositoryDeployKeys.java.md) +- [dataGithubRepositoryDeploymentBranchPolicies](./dataGithubRepositoryDeploymentBranchPolicies.java.md) +- [dataGithubRepositoryEnvironmentDeploymentPolicies](./dataGithubRepositoryEnvironmentDeploymentPolicies.java.md) +- [dataGithubRepositoryEnvironments](./dataGithubRepositoryEnvironments.java.md) +- [dataGithubRepositoryFile](./dataGithubRepositoryFile.java.md) +- [dataGithubRepositoryMilestone](./dataGithubRepositoryMilestone.java.md) +- [dataGithubRepositoryPages](./dataGithubRepositoryPages.java.md) +- [dataGithubRepositoryPullRequest](./dataGithubRepositoryPullRequest.java.md) +- [dataGithubRepositoryPullRequests](./dataGithubRepositoryPullRequests.java.md) +- [dataGithubRepositoryTeams](./dataGithubRepositoryTeams.java.md) +- [dataGithubRepositoryWebhooks](./dataGithubRepositoryWebhooks.java.md) +- [dataGithubRestApi](./dataGithubRestApi.java.md) +- [dataGithubSshKeys](./dataGithubSshKeys.java.md) +- [dataGithubTeam](./dataGithubTeam.java.md) +- [dataGithubTree](./dataGithubTree.java.md) +- [dataGithubUser](./dataGithubUser.java.md) +- [dataGithubUserExternalIdentity](./dataGithubUserExternalIdentity.java.md) +- [dataGithubUsers](./dataGithubUsers.java.md) +- [dependabotOrganizationSecret](./dependabotOrganizationSecret.java.md) +- [dependabotOrganizationSecretRepositories](./dependabotOrganizationSecretRepositories.java.md) +- [dependabotOrganizationSecretRepository](./dependabotOrganizationSecretRepository.java.md) +- [dependabotSecret](./dependabotSecret.java.md) +- [emuGroupMapping](./emuGroupMapping.java.md) +- [enterpriseActionsPermissions](./enterpriseActionsPermissions.java.md) +- [enterpriseActionsRunnerGroup](./enterpriseActionsRunnerGroup.java.md) +- [enterpriseActionsWorkflowPermissions](./enterpriseActionsWorkflowPermissions.java.md) +- [enterpriseIpAllowListEntry](./enterpriseIpAllowListEntry.java.md) +- [enterpriseOrganization](./enterpriseOrganization.java.md) +- [enterpriseSecurityAnalysisSettings](./enterpriseSecurityAnalysisSettings.java.md) +- [issue](./issue.java.md) +- [issueLabel](./issueLabel.java.md) +- [issueLabels](./issueLabels.java.md) +- [membership](./membership.java.md) +- [organizationBlock](./organizationBlock.java.md) +- [organizationCustomProperties](./organizationCustomProperties.java.md) +- [organizationCustomRole](./organizationCustomRole.java.md) +- [organizationProject](./organizationProject.java.md) +- [organizationRepositoryRole](./organizationRepositoryRole.java.md) +- [organizationRole](./organizationRole.java.md) +- [organizationRoleTeam](./organizationRoleTeam.java.md) +- [organizationRoleTeamAssignment](./organizationRoleTeamAssignment.java.md) +- [organizationRoleUser](./organizationRoleUser.java.md) +- [organizationRuleset](./organizationRuleset.java.md) +- [organizationSecurityManager](./organizationSecurityManager.java.md) +- [organizationSettings](./organizationSettings.java.md) +- [organizationWebhook](./organizationWebhook.java.md) +- [projectCard](./projectCard.java.md) +- [projectColumn](./projectColumn.java.md) +- [provider](./provider.java.md) +- [release](./release.java.md) +- [repository](./repository.java.md) +- [repositoryAutolinkReference](./repositoryAutolinkReference.java.md) +- [repositoryCollaborator](./repositoryCollaborator.java.md) +- [repositoryCollaborators](./repositoryCollaborators.java.md) +- [repositoryCustomProperty](./repositoryCustomProperty.java.md) +- [repositoryDependabotSecurityUpdates](./repositoryDependabotSecurityUpdates.java.md) +- [repositoryDeployKey](./repositoryDeployKey.java.md) +- [repositoryDeploymentBranchPolicy](./repositoryDeploymentBranchPolicy.java.md) +- [repositoryEnvironment](./repositoryEnvironment.java.md) +- [repositoryEnvironmentDeploymentPolicy](./repositoryEnvironmentDeploymentPolicy.java.md) +- [repositoryFile](./repositoryFile.java.md) +- [repositoryMilestone](./repositoryMilestone.java.md) +- [repositoryPages](./repositoryPages.java.md) +- [repositoryProject](./repositoryProject.java.md) +- [repositoryPullRequest](./repositoryPullRequest.java.md) +- [repositoryRuleset](./repositoryRuleset.java.md) +- [repositoryTopics](./repositoryTopics.java.md) +- [repositoryVulnerabilityAlerts](./repositoryVulnerabilityAlerts.java.md) +- [repositoryWebhook](./repositoryWebhook.java.md) +- [team](./team.java.md) +- [teamMembers](./teamMembers.java.md) +- [teamMembership](./teamMembership.java.md) +- [teamRepository](./teamRepository.java.md) +- [teamSettings](./teamSettings.java.md) +- [teamSyncGroupMapping](./teamSyncGroupMapping.java.md) +- [userGpgKey](./userGpgKey.java.md) +- [userInvitationAccepter](./userInvitationAccepter.java.md) +- [userSshKey](./userSshKey.java.md) +- [workflowRepositoryPermissions](./workflowRepositoryPermissions.java.md) + + + + + diff --git a/docs/actionsEnvironmentSecret.csharp.md b/docs/actionsEnvironmentSecret.csharp.md new file mode 100644 index 000000000..b97e6b8e8 --- /dev/null +++ b/docs/actionsEnvironmentSecret.csharp.md @@ -0,0 +1,1219 @@ +# `actionsEnvironmentSecret` Submodule + +## Constructs + +### ActionsEnvironmentSecret + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret github_actions_environment_secret}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsEnvironmentSecret(Construct Scope, string Id, ActionsEnvironmentSecretConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | ActionsEnvironmentSecretConfig | *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:* ActionsEnvironmentSecretConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetEncryptedValue | *No description.* | +| ResetId | *No description.* | +| ResetKeyId | *No description.* | +| ResetPlaintextValue | *No description.* | +| ResetValue | *No description.* | +| ResetValueEncrypted | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetEncryptedValue` + +```csharp +private void ResetEncryptedValue() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetKeyId` + +```csharp +private void ResetKeyId() +``` + +##### `ResetPlaintextValue` + +```csharp +private void ResetPlaintextValue() +``` + +##### `ResetValue` + +```csharp +private void ResetValue() +``` + +##### `ResetValueEncrypted` + +```csharp +private void ResetValueEncrypted() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a ActionsEnvironmentSecret resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsEnvironmentSecret.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` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsEnvironmentSecret.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsEnvironmentSecret.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsEnvironmentSecret.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a ActionsEnvironmentSecret resource upon running "cdktn 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 ActionsEnvironmentSecret to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing ActionsEnvironmentSecret that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the ActionsEnvironmentSecret to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| CreatedAt | string | *No description.* | +| RemoteUpdatedAt | string | *No description.* | +| RepositoryId | double | *No description.* | +| UpdatedAt | string | *No description.* | +| EncryptedValueInput | string | *No description.* | +| EnvironmentInput | string | *No description.* | +| IdInput | string | *No description.* | +| KeyIdInput | string | *No description.* | +| PlaintextValueInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| SecretNameInput | string | *No description.* | +| ValueEncryptedInput | string | *No description.* | +| ValueInput | string | *No description.* | +| EncryptedValue | string | *No description.* | +| Environment | string | *No description.* | +| Id | string | *No description.* | +| KeyId | string | *No description.* | +| PlaintextValue | string | *No description.* | +| Repository | string | *No description.* | +| SecretName | string | *No description.* | +| Value | string | *No description.* | +| ValueEncrypted | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `RemoteUpdatedAt`Required + +```csharp +public string RemoteUpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryId`Required + +```csharp +public double RepositoryId { get; } +``` + +- *Type:* double + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `EncryptedValueInput`Optional + +```csharp +public string EncryptedValueInput { get; } +``` + +- *Type:* string + +--- + +##### `EnvironmentInput`Optional + +```csharp +public string EnvironmentInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `KeyIdInput`Optional + +```csharp +public string KeyIdInput { get; } +``` + +- *Type:* string + +--- + +##### `PlaintextValueInput`Optional + +```csharp +public string PlaintextValueInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `SecretNameInput`Optional + +```csharp +public string SecretNameInput { get; } +``` + +- *Type:* string + +--- + +##### `ValueEncryptedInput`Optional + +```csharp +public string ValueEncryptedInput { get; } +``` + +- *Type:* string + +--- + +##### `ValueInput`Optional + +```csharp +public string ValueInput { get; } +``` + +- *Type:* string + +--- + +##### `EncryptedValue`Required + +```csharp +public string EncryptedValue { get; } +``` + +- *Type:* string + +--- + +##### `Environment`Required + +```csharp +public string Environment { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `KeyId`Required + +```csharp +public string KeyId { get; } +``` + +- *Type:* string + +--- + +##### `PlaintextValue`Required + +```csharp +public string PlaintextValue { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; } +``` + +- *Type:* string + +--- + +##### `Value`Required + +```csharp +public string Value { get; } +``` + +- *Type:* string + +--- + +##### `ValueEncrypted`Required + +```csharp +public string ValueEncrypted { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### ActionsEnvironmentSecretConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsEnvironmentSecretConfig { + 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 Environment, + string Repository, + string SecretName, + string EncryptedValue = null, + string Id = null, + string KeyId = null, + string PlaintextValue = null, + string Value = null, + string ValueEncrypted = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Environment | string | Name of the environment. | +| Repository | string | Name of the repository. | +| SecretName | string | Name of the secret. | +| EncryptedValue | string | Encrypted value of the secret using the GitHub public key in Base64 format. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#id ActionsEnvironmentSecret#id}. | +| KeyId | string | ID of the public key used to encrypt the secret. | +| PlaintextValue | string | Plaintext value of the secret to be encrypted. | +| Value | string | Plaintext value to be encrypted. | +| ValueEncrypted | string | Value encrypted with the GitHub public key, defined by key_id, in Base64 format. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Environment`Required + +```csharp +public string Environment { get; set; } +``` + +- *Type:* string + +Name of the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#environment ActionsEnvironmentSecret#environment} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#repository ActionsEnvironmentSecret#repository} + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; set; } +``` + +- *Type:* string + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#secret_name ActionsEnvironmentSecret#secret_name} + +--- + +##### `EncryptedValue`Optional + +```csharp +public string EncryptedValue { get; set; } +``` + +- *Type:* string + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#encrypted_value ActionsEnvironmentSecret#encrypted_value} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#id ActionsEnvironmentSecret#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. + +--- + +##### `KeyId`Optional + +```csharp +public string KeyId { get; set; } +``` + +- *Type:* string + +ID of the public key used to encrypt the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#key_id ActionsEnvironmentSecret#key_id} + +--- + +##### `PlaintextValue`Optional + +```csharp +public string PlaintextValue { get; set; } +``` + +- *Type:* string + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#plaintext_value ActionsEnvironmentSecret#plaintext_value} + +--- + +##### `Value`Optional + +```csharp +public string Value { get; set; } +``` + +- *Type:* string + +Plaintext value to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#value ActionsEnvironmentSecret#value} + +--- + +##### `ValueEncrypted`Optional + +```csharp +public string ValueEncrypted { get; set; } +``` + +- *Type:* string + +Value encrypted with the GitHub public key, defined by key_id, in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#value_encrypted ActionsEnvironmentSecret#value_encrypted} + +--- + + + diff --git a/docs/actionsEnvironmentSecret.java.md b/docs/actionsEnvironmentSecret.java.md new file mode 100644 index 000000000..75e9a39aa --- /dev/null +++ b/docs/actionsEnvironmentSecret.java.md @@ -0,0 +1,1380 @@ +# `actionsEnvironmentSecret` Submodule + +## Constructs + +### ActionsEnvironmentSecret + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret github_actions_environment_secret}. + +#### Initializers + +```java +import io.cdktn.providers.github.actions_environment_secret.ActionsEnvironmentSecret; + +ActionsEnvironmentSecret.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .environment(java.lang.String) + .repository(java.lang.String) + .secretName(java.lang.String) +// .encryptedValue(java.lang.String) +// .id(java.lang.String) +// .keyId(java.lang.String) +// .plaintextValue(java.lang.String) +// .value(java.lang.String) +// .valueEncrypted(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 | *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 | *No description.* | +| environment | java.lang.String | Name of the environment. | +| repository | java.lang.String | Name of the repository. | +| secretName | java.lang.String | Name of the secret. | +| encryptedValue | java.lang.String | Encrypted value of the secret using the GitHub public key in Base64 format. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#id ActionsEnvironmentSecret#id}. | +| keyId | java.lang.String | ID of the public key used to encrypt the secret. | +| plaintextValue | java.lang.String | Plaintext value of the secret to be encrypted. | +| value | java.lang.String | Plaintext value to be encrypted. | +| valueEncrypted | java.lang.String | Value encrypted with the GitHub public key, defined by key_id, in Base64 format. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `environment`Required + +- *Type:* java.lang.String + +Name of the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#environment ActionsEnvironmentSecret#environment} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#repository ActionsEnvironmentSecret#repository} + +--- + +##### `secretName`Required + +- *Type:* java.lang.String + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#secret_name ActionsEnvironmentSecret#secret_name} + +--- + +##### `encryptedValue`Optional + +- *Type:* java.lang.String + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#encrypted_value ActionsEnvironmentSecret#encrypted_value} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#id ActionsEnvironmentSecret#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. + +--- + +##### `keyId`Optional + +- *Type:* java.lang.String + +ID of the public key used to encrypt the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#key_id ActionsEnvironmentSecret#key_id} + +--- + +##### `plaintextValue`Optional + +- *Type:* java.lang.String + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#plaintext_value ActionsEnvironmentSecret#plaintext_value} + +--- + +##### `value`Optional + +- *Type:* java.lang.String + +Plaintext value to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#value ActionsEnvironmentSecret#value} + +--- + +##### `valueEncrypted`Optional + +- *Type:* java.lang.String + +Value encrypted with the GitHub public key, defined by key_id, in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#value_encrypted ActionsEnvironmentSecret#value_encrypted} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetEncryptedValue | *No description.* | +| resetId | *No description.* | +| resetKeyId | *No description.* | +| resetPlaintextValue | *No description.* | +| resetValue | *No description.* | +| resetValueEncrypted | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetEncryptedValue` + +```java +public void resetEncryptedValue() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetKeyId` + +```java +public void resetKeyId() +``` + +##### `resetPlaintextValue` + +```java +public void resetPlaintextValue() +``` + +##### `resetValue` + +```java +public void resetValue() +``` + +##### `resetValueEncrypted` + +```java +public void resetValueEncrypted() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a ActionsEnvironmentSecret resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.actions_environment_secret.ActionsEnvironmentSecret; + +ActionsEnvironmentSecret.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` + +```java +import io.cdktn.providers.github.actions_environment_secret.ActionsEnvironmentSecret; + +ActionsEnvironmentSecret.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.actions_environment_secret.ActionsEnvironmentSecret; + +ActionsEnvironmentSecret.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.actions_environment_secret.ActionsEnvironmentSecret; + +ActionsEnvironmentSecret.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ActionsEnvironmentSecret.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a ActionsEnvironmentSecret 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 ActionsEnvironmentSecret to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing ActionsEnvironmentSecret that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#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 ActionsEnvironmentSecret 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| createdAt | java.lang.String | *No description.* | +| remoteUpdatedAt | java.lang.String | *No description.* | +| repositoryId | java.lang.Number | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| encryptedValueInput | java.lang.String | *No description.* | +| environmentInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| keyIdInput | java.lang.String | *No description.* | +| plaintextValueInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| secretNameInput | java.lang.String | *No description.* | +| valueEncryptedInput | java.lang.String | *No description.* | +| valueInput | java.lang.String | *No description.* | +| encryptedValue | java.lang.String | *No description.* | +| environment | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| keyId | java.lang.String | *No description.* | +| plaintextValue | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | +| secretName | java.lang.String | *No description.* | +| value | java.lang.String | *No description.* | +| valueEncrypted | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `remoteUpdatedAt`Required + +```java +public java.lang.String getRemoteUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryId`Required + +```java +public java.lang.Number getRepositoryId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `encryptedValueInput`Optional + +```java +public java.lang.String getEncryptedValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `environmentInput`Optional + +```java +public java.lang.String getEnvironmentInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `keyIdInput`Optional + +```java +public java.lang.String getKeyIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `plaintextValueInput`Optional + +```java +public java.lang.String getPlaintextValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretNameInput`Optional + +```java +public java.lang.String getSecretNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `valueEncryptedInput`Optional + +```java +public java.lang.String getValueEncryptedInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `valueInput`Optional + +```java +public java.lang.String getValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `encryptedValue`Required + +```java +public java.lang.String getEncryptedValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `environment`Required + +```java +public java.lang.String getEnvironment(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `keyId`Required + +```java +public java.lang.String getKeyId(); +``` + +- *Type:* java.lang.String + +--- + +##### `plaintextValue`Required + +```java +public java.lang.String getPlaintextValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +--- + +##### `value`Required + +```java +public java.lang.String getValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `valueEncrypted`Required + +```java +public java.lang.String getValueEncrypted(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### ActionsEnvironmentSecretConfig + +#### Initializer + +```java +import io.cdktn.providers.github.actions_environment_secret.ActionsEnvironmentSecretConfig; + +ActionsEnvironmentSecretConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .environment(java.lang.String) + .repository(java.lang.String) + .secretName(java.lang.String) +// .encryptedValue(java.lang.String) +// .id(java.lang.String) +// .keyId(java.lang.String) +// .plaintextValue(java.lang.String) +// .value(java.lang.String) +// .valueEncrypted(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 | *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 | *No description.* | +| environment | java.lang.String | Name of the environment. | +| repository | java.lang.String | Name of the repository. | +| secretName | java.lang.String | Name of the secret. | +| encryptedValue | java.lang.String | Encrypted value of the secret using the GitHub public key in Base64 format. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#id ActionsEnvironmentSecret#id}. | +| keyId | java.lang.String | ID of the public key used to encrypt the secret. | +| plaintextValue | java.lang.String | Plaintext value of the secret to be encrypted. | +| value | java.lang.String | Plaintext value to be encrypted. | +| valueEncrypted | java.lang.String | Value encrypted with the GitHub public key, defined by key_id, in Base64 format. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `environment`Required + +```java +public java.lang.String getEnvironment(); +``` + +- *Type:* java.lang.String + +Name of the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#environment ActionsEnvironmentSecret#environment} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#repository ActionsEnvironmentSecret#repository} + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#secret_name ActionsEnvironmentSecret#secret_name} + +--- + +##### `encryptedValue`Optional + +```java +public java.lang.String getEncryptedValue(); +``` + +- *Type:* java.lang.String + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#encrypted_value ActionsEnvironmentSecret#encrypted_value} + +--- + +##### `id`Optional + +```java +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/resources/actions_environment_secret#id ActionsEnvironmentSecret#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. + +--- + +##### `keyId`Optional + +```java +public java.lang.String getKeyId(); +``` + +- *Type:* java.lang.String + +ID of the public key used to encrypt the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#key_id ActionsEnvironmentSecret#key_id} + +--- + +##### `plaintextValue`Optional + +```java +public java.lang.String getPlaintextValue(); +``` + +- *Type:* java.lang.String + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#plaintext_value ActionsEnvironmentSecret#plaintext_value} + +--- + +##### `value`Optional + +```java +public java.lang.String getValue(); +``` + +- *Type:* java.lang.String + +Plaintext value to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#value ActionsEnvironmentSecret#value} + +--- + +##### `valueEncrypted`Optional + +```java +public java.lang.String getValueEncrypted(); +``` + +- *Type:* java.lang.String + +Value encrypted with the GitHub public key, defined by key_id, in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_secret#value_encrypted ActionsEnvironmentSecret#value_encrypted} + +--- + + + diff --git a/docs/actionsEnvironmentVariable.csharp.md b/docs/actionsEnvironmentVariable.csharp.md new file mode 100644 index 000000000..c99cf967f --- /dev/null +++ b/docs/actionsEnvironmentVariable.csharp.md @@ -0,0 +1,1021 @@ +# `actionsEnvironmentVariable` Submodule + +## Constructs + +### ActionsEnvironmentVariable + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_variable github_actions_environment_variable}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsEnvironmentVariable(Construct Scope, string Id, ActionsEnvironmentVariableConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | ActionsEnvironmentVariableConfig | *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:* ActionsEnvironmentVariableConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a ActionsEnvironmentVariable resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsEnvironmentVariable.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` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsEnvironmentVariable.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsEnvironmentVariable.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsEnvironmentVariable.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a ActionsEnvironmentVariable resource upon running "cdktn 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 ActionsEnvironmentVariable to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing ActionsEnvironmentVariable that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_variable#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the ActionsEnvironmentVariable to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| CreatedAt | string | *No description.* | +| RepositoryId | double | *No description.* | +| UpdatedAt | string | *No description.* | +| EnvironmentInput | string | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| ValueInput | string | *No description.* | +| VariableNameInput | string | *No description.* | +| Environment | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | +| Value | string | *No description.* | +| VariableName | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryId`Required + +```csharp +public double RepositoryId { get; } +``` + +- *Type:* double + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `EnvironmentInput`Optional + +```csharp +public string EnvironmentInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `ValueInput`Optional + +```csharp +public string ValueInput { get; } +``` + +- *Type:* string + +--- + +##### `VariableNameInput`Optional + +```csharp +public string VariableNameInput { get; } +``` + +- *Type:* string + +--- + +##### `Environment`Required + +```csharp +public string Environment { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `Value`Required + +```csharp +public string Value { get; } +``` + +- *Type:* string + +--- + +##### `VariableName`Required + +```csharp +public string VariableName { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### ActionsEnvironmentVariableConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsEnvironmentVariableConfig { + 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 Environment, + string Repository, + string Value, + string VariableName, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Environment | string | Name of the environment. | +| Repository | string | Name of the repository. | +| Value | string | Value of the variable. | +| VariableName | string | Name of the variable. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_variable#id ActionsEnvironmentVariable#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Environment`Required + +```csharp +public string Environment { get; set; } +``` + +- *Type:* string + +Name of the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_variable#environment ActionsEnvironmentVariable#environment} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_variable#repository ActionsEnvironmentVariable#repository} + +--- + +##### `Value`Required + +```csharp +public string Value { get; set; } +``` + +- *Type:* string + +Value of the variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_variable#value ActionsEnvironmentVariable#value} + +--- + +##### `VariableName`Required + +```csharp +public string VariableName { get; set; } +``` + +- *Type:* string + +Name of the variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_variable#variable_name ActionsEnvironmentVariable#variable_name} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_variable#id ActionsEnvironmentVariable#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. + +--- + + + diff --git a/docs/actionsEnvironmentVariable.java.md b/docs/actionsEnvironmentVariable.java.md new file mode 100644 index 000000000..002a1b365 --- /dev/null +++ b/docs/actionsEnvironmentVariable.java.md @@ -0,0 +1,1134 @@ +# `actionsEnvironmentVariable` Submodule + +## Constructs + +### ActionsEnvironmentVariable + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_variable github_actions_environment_variable}. + +#### Initializers + +```java +import io.cdktn.providers.github.actions_environment_variable.ActionsEnvironmentVariable; + +ActionsEnvironmentVariable.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .environment(java.lang.String) + .repository(java.lang.String) + .value(java.lang.String) + .variableName(java.lang.String) +// .id(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 | *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 | *No description.* | +| environment | java.lang.String | Name of the environment. | +| repository | java.lang.String | Name of the repository. | +| value | java.lang.String | Value of the variable. | +| variableName | java.lang.String | Name of the variable. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_variable#id ActionsEnvironmentVariable#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `environment`Required + +- *Type:* java.lang.String + +Name of the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_variable#environment ActionsEnvironmentVariable#environment} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_variable#repository ActionsEnvironmentVariable#repository} + +--- + +##### `value`Required + +- *Type:* java.lang.String + +Value of the variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_variable#value ActionsEnvironmentVariable#value} + +--- + +##### `variableName`Required + +- *Type:* java.lang.String + +Name of the variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_variable#variable_name ActionsEnvironmentVariable#variable_name} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_variable#id ActionsEnvironmentVariable#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a ActionsEnvironmentVariable resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.actions_environment_variable.ActionsEnvironmentVariable; + +ActionsEnvironmentVariable.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` + +```java +import io.cdktn.providers.github.actions_environment_variable.ActionsEnvironmentVariable; + +ActionsEnvironmentVariable.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.actions_environment_variable.ActionsEnvironmentVariable; + +ActionsEnvironmentVariable.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.actions_environment_variable.ActionsEnvironmentVariable; + +ActionsEnvironmentVariable.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ActionsEnvironmentVariable.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a ActionsEnvironmentVariable 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 ActionsEnvironmentVariable to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing ActionsEnvironmentVariable that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_variable#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 ActionsEnvironmentVariable 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| createdAt | java.lang.String | *No description.* | +| repositoryId | java.lang.Number | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| environmentInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| valueInput | java.lang.String | *No description.* | +| variableNameInput | java.lang.String | *No description.* | +| environment | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | +| value | java.lang.String | *No description.* | +| variableName | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryId`Required + +```java +public java.lang.Number getRepositoryId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `environmentInput`Optional + +```java +public java.lang.String getEnvironmentInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `valueInput`Optional + +```java +public java.lang.String getValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `variableNameInput`Optional + +```java +public java.lang.String getVariableNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `environment`Required + +```java +public java.lang.String getEnvironment(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `value`Required + +```java +public java.lang.String getValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `variableName`Required + +```java +public java.lang.String getVariableName(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### ActionsEnvironmentVariableConfig + +#### Initializer + +```java +import io.cdktn.providers.github.actions_environment_variable.ActionsEnvironmentVariableConfig; + +ActionsEnvironmentVariableConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .environment(java.lang.String) + .repository(java.lang.String) + .value(java.lang.String) + .variableName(java.lang.String) +// .id(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 | *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 | *No description.* | +| environment | java.lang.String | Name of the environment. | +| repository | java.lang.String | Name of the repository. | +| value | java.lang.String | Value of the variable. | +| variableName | java.lang.String | Name of the variable. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_variable#id ActionsEnvironmentVariable#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `environment`Required + +```java +public java.lang.String getEnvironment(); +``` + +- *Type:* java.lang.String + +Name of the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_variable#environment ActionsEnvironmentVariable#environment} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_variable#repository ActionsEnvironmentVariable#repository} + +--- + +##### `value`Required + +```java +public java.lang.String getValue(); +``` + +- *Type:* java.lang.String + +Value of the variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_variable#value ActionsEnvironmentVariable#value} + +--- + +##### `variableName`Required + +```java +public java.lang.String getVariableName(); +``` + +- *Type:* java.lang.String + +Name of the variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_environment_variable#variable_name ActionsEnvironmentVariable#variable_name} + +--- + +##### `id`Optional + +```java +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/resources/actions_environment_variable#id ActionsEnvironmentVariable#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. + +--- + + + diff --git a/docs/actionsHostedRunner.csharp.md b/docs/actionsHostedRunner.csharp.md new file mode 100644 index 000000000..c0cd9792c --- /dev/null +++ b/docs/actionsHostedRunner.csharp.md @@ -0,0 +1,2871 @@ +# `actionsHostedRunner` Submodule + +## Constructs + +### ActionsHostedRunner + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner github_actions_hosted_runner}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsHostedRunner(Construct Scope, string Id, ActionsHostedRunnerConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | ActionsHostedRunnerConfig | *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:* ActionsHostedRunnerConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| PutImage | *No description.* | +| PutTimeouts | *No description.* | +| ResetImageGen | *No description.* | +| ResetImageVersion | *No description.* | +| ResetMaximumRunners | *No description.* | +| ResetPublicIpEnabled | *No description.* | +| ResetTimeouts | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `PutImage` + +```csharp +private void PutImage(ActionsHostedRunnerImage Value) +``` + +###### `Value`Required + +- *Type:* ActionsHostedRunnerImage + +--- + +##### `PutTimeouts` + +```csharp +private void PutTimeouts(ActionsHostedRunnerTimeouts Value) +``` + +###### `Value`Required + +- *Type:* ActionsHostedRunnerTimeouts + +--- + +##### `ResetImageGen` + +```csharp +private void ResetImageGen() +``` + +##### `ResetImageVersion` + +```csharp +private void ResetImageVersion() +``` + +##### `ResetMaximumRunners` + +```csharp +private void ResetMaximumRunners() +``` + +##### `ResetPublicIpEnabled` + +```csharp +private void ResetPublicIpEnabled() +``` + +##### `ResetTimeouts` + +```csharp +private void ResetTimeouts() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a ActionsHostedRunner resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsHostedRunner.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` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsHostedRunner.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsHostedRunner.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsHostedRunner.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a ActionsHostedRunner resource upon running "cdktn 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 ActionsHostedRunner to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing ActionsHostedRunner that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the ActionsHostedRunner to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | *No description.* | +| Image | ActionsHostedRunnerImageOutputReference | *No description.* | +| LastActiveOn | string | *No description.* | +| MachineSizeDetails | ActionsHostedRunnerMachineSizeDetailsList | *No description.* | +| Platform | string | *No description.* | +| PublicIps | ActionsHostedRunnerPublicIpsList | *No description.* | +| Status | string | *No description.* | +| Timeouts | ActionsHostedRunnerTimeoutsOutputReference | *No description.* | +| ImageGenInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| ImageInput | ActionsHostedRunnerImage | *No description.* | +| ImageVersionInput | string | *No description.* | +| MaximumRunnersInput | double | *No description.* | +| NameInput | string | *No description.* | +| PublicIpEnabledInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RunnerGroupIdInput | double | *No description.* | +| SizeInput | string | *No description.* | +| TimeoutsInput | Io.Cdktn.IResolvable\|ActionsHostedRunnerTimeouts | *No description.* | +| ImageGen | bool\|Io.Cdktn.IResolvable | *No description.* | +| ImageVersion | string | *No description.* | +| MaximumRunners | double | *No description.* | +| Name | string | *No description.* | +| PublicIpEnabled | bool\|Io.Cdktn.IResolvable | *No description.* | +| RunnerGroupId | double | *No description.* | +| Size | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Image`Required + +```csharp +public ActionsHostedRunnerImageOutputReference Image { get; } +``` + +- *Type:* ActionsHostedRunnerImageOutputReference + +--- + +##### `LastActiveOn`Required + +```csharp +public string LastActiveOn { get; } +``` + +- *Type:* string + +--- + +##### `MachineSizeDetails`Required + +```csharp +public ActionsHostedRunnerMachineSizeDetailsList MachineSizeDetails { get; } +``` + +- *Type:* ActionsHostedRunnerMachineSizeDetailsList + +--- + +##### `Platform`Required + +```csharp +public string Platform { get; } +``` + +- *Type:* string + +--- + +##### `PublicIps`Required + +```csharp +public ActionsHostedRunnerPublicIpsList PublicIps { get; } +``` + +- *Type:* ActionsHostedRunnerPublicIpsList + +--- + +##### `Status`Required + +```csharp +public string Status { get; } +``` + +- *Type:* string + +--- + +##### `Timeouts`Required + +```csharp +public ActionsHostedRunnerTimeoutsOutputReference Timeouts { get; } +``` + +- *Type:* ActionsHostedRunnerTimeoutsOutputReference + +--- + +##### `ImageGenInput`Optional + +```csharp +public bool|IResolvable ImageGenInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ImageInput`Optional + +```csharp +public ActionsHostedRunnerImage ImageInput { get; } +``` + +- *Type:* ActionsHostedRunnerImage + +--- + +##### `ImageVersionInput`Optional + +```csharp +public string ImageVersionInput { get; } +``` + +- *Type:* string + +--- + +##### `MaximumRunnersInput`Optional + +```csharp +public double MaximumRunnersInput { get; } +``` + +- *Type:* double + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `PublicIpEnabledInput`Optional + +```csharp +public bool|IResolvable PublicIpEnabledInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RunnerGroupIdInput`Optional + +```csharp +public double RunnerGroupIdInput { get; } +``` + +- *Type:* double + +--- + +##### `SizeInput`Optional + +```csharp +public string SizeInput { get; } +``` + +- *Type:* string + +--- + +##### `TimeoutsInput`Optional + +```csharp +public IResolvable|ActionsHostedRunnerTimeouts TimeoutsInput { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|ActionsHostedRunnerTimeouts + +--- + +##### `ImageGen`Required + +```csharp +public bool|IResolvable ImageGen { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ImageVersion`Required + +```csharp +public string ImageVersion { get; } +``` + +- *Type:* string + +--- + +##### `MaximumRunners`Required + +```csharp +public double MaximumRunners { get; } +``` + +- *Type:* double + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `PublicIpEnabled`Required + +```csharp +public bool|IResolvable PublicIpEnabled { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RunnerGroupId`Required + +```csharp +public double RunnerGroupId { get; } +``` + +- *Type:* double + +--- + +##### `Size`Required + +```csharp +public string Size { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### ActionsHostedRunnerConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsHostedRunnerConfig { + 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, + ActionsHostedRunnerImage Image, + string Name, + double RunnerGroupId, + string Size, + bool|IResolvable ImageGen = null, + string ImageVersion = null, + double MaximumRunners = null, + bool|IResolvable PublicIpEnabled = null, + ActionsHostedRunnerTimeouts Timeouts = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Image | ActionsHostedRunnerImage | image block. | +| Name | string | Name of the hosted runner. | +| RunnerGroupId | double | The runner group ID. | +| Size | string | Machine size (e.g., '4-core', '8-core'). Can be updated to scale the runner. | +| ImageGen | bool\|Io.Cdktn.IResolvable | Whether this runner should be used to generate custom images. Cannot be changed after creation. | +| ImageVersion | string | The version of the runner image to deploy. This is relevant only for runners using custom images. | +| MaximumRunners | double | Maximum number of runners to scale up to. | +| PublicIpEnabled | bool\|Io.Cdktn.IResolvable | Whether to enable static public IP. | +| Timeouts | ActionsHostedRunnerTimeouts | timeouts block. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Image`Required + +```csharp +public ActionsHostedRunnerImage Image { get; set; } +``` + +- *Type:* ActionsHostedRunnerImage + +image block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#image ActionsHostedRunner#image} + +--- + +##### `Name`Required + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +Name of the hosted runner. + +Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#name ActionsHostedRunner#name} + +--- + +##### `RunnerGroupId`Required + +```csharp +public double RunnerGroupId { get; set; } +``` + +- *Type:* double + +The runner group ID. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#runner_group_id ActionsHostedRunner#runner_group_id} + +--- + +##### `Size`Required + +```csharp +public string Size { get; set; } +``` + +- *Type:* string + +Machine size (e.g., '4-core', '8-core'). Can be updated to scale the runner. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#size ActionsHostedRunner#size} + +--- + +##### `ImageGen`Optional + +```csharp +public bool|IResolvable ImageGen { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether this runner should be used to generate custom images. Cannot be changed after creation. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#image_gen ActionsHostedRunner#image_gen} + +--- + +##### `ImageVersion`Optional + +```csharp +public string ImageVersion { get; set; } +``` + +- *Type:* string + +The version of the runner image to deploy. This is relevant only for runners using custom images. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#image_version ActionsHostedRunner#image_version} + +--- + +##### `MaximumRunners`Optional + +```csharp +public double MaximumRunners { get; set; } +``` + +- *Type:* double + +Maximum number of runners to scale up to. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#maximum_runners ActionsHostedRunner#maximum_runners} + +--- + +##### `PublicIpEnabled`Optional + +```csharp +public bool|IResolvable PublicIpEnabled { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether to enable static public IP. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#public_ip_enabled ActionsHostedRunner#public_ip_enabled} + +--- + +##### `Timeouts`Optional + +```csharp +public ActionsHostedRunnerTimeouts Timeouts { get; set; } +``` + +- *Type:* ActionsHostedRunnerTimeouts + +timeouts block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#timeouts ActionsHostedRunner#timeouts} + +--- + +### ActionsHostedRunnerImage + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsHostedRunnerImage { + string Id, + string Source = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Id | string | The image ID. | +| Source | string | The image source (github, partner, or custom). | + +--- + +##### `Id`Required + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +The image ID. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#id ActionsHostedRunner#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. + +--- + +##### `Source`Optional + +```csharp +public string Source { get; set; } +``` + +- *Type:* string + +The image source (github, partner, or custom). + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#source ActionsHostedRunner#source} + +--- + +### ActionsHostedRunnerMachineSizeDetails + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsHostedRunnerMachineSizeDetails { + +}; +``` + + +### ActionsHostedRunnerPublicIps + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsHostedRunnerPublicIps { + +}; +``` + + +### ActionsHostedRunnerTimeouts + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsHostedRunnerTimeouts { + string Delete = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Delete | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#delete ActionsHostedRunner#delete}. | + +--- + +##### `Delete`Optional + +```csharp +public string Delete { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#delete ActionsHostedRunner#delete}. + +--- + +## Classes + +### ActionsHostedRunnerImageOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsHostedRunnerImageOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetSource | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetSource` + +```csharp +private void ResetSource() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| SizeGb | double | *No description.* | +| IdInput | string | *No description.* | +| SourceInput | string | *No description.* | +| Id | string | *No description.* | +| Source | string | *No description.* | +| InternalValue | ActionsHostedRunnerImage | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `SizeGb`Required + +```csharp +public double SizeGb { get; } +``` + +- *Type:* double + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `SourceInput`Optional + +```csharp +public string SourceInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Source`Required + +```csharp +public string Source { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public ActionsHostedRunnerImage InternalValue { get; } +``` + +- *Type:* ActionsHostedRunnerImage + +--- + + +### ActionsHostedRunnerMachineSizeDetailsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsHostedRunnerMachineSizeDetailsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private ActionsHostedRunnerMachineSizeDetailsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### ActionsHostedRunnerMachineSizeDetailsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsHostedRunnerMachineSizeDetailsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| CpuCores | double | *No description.* | +| Id | string | *No description.* | +| MemoryGb | double | *No description.* | +| StorageGb | double | *No description.* | +| InternalValue | ActionsHostedRunnerMachineSizeDetails | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `CpuCores`Required + +```csharp +public double CpuCores { get; } +``` + +- *Type:* double + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `MemoryGb`Required + +```csharp +public double MemoryGb { get; } +``` + +- *Type:* double + +--- + +##### `StorageGb`Required + +```csharp +public double StorageGb { get; } +``` + +- *Type:* double + +--- + +##### `InternalValue`Optional + +```csharp +public ActionsHostedRunnerMachineSizeDetails InternalValue { get; } +``` + +- *Type:* ActionsHostedRunnerMachineSizeDetails + +--- + + +### ActionsHostedRunnerPublicIpsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsHostedRunnerPublicIpsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private ActionsHostedRunnerPublicIpsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### ActionsHostedRunnerPublicIpsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsHostedRunnerPublicIpsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Enabled | Io.Cdktn.IResolvable | *No description.* | +| Length | double | *No description.* | +| Prefix | string | *No description.* | +| InternalValue | ActionsHostedRunnerPublicIps | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Enabled`Required + +```csharp +public IResolvable Enabled { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `Length`Required + +```csharp +public double Length { get; } +``` + +- *Type:* double + +--- + +##### `Prefix`Required + +```csharp +public string Prefix { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public ActionsHostedRunnerPublicIps InternalValue { get; } +``` + +- *Type:* ActionsHostedRunnerPublicIps + +--- + + +### ActionsHostedRunnerTimeoutsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsHostedRunnerTimeoutsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetDelete | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetDelete` + +```csharp +private void ResetDelete() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| DeleteInput | string | *No description.* | +| Delete | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|ActionsHostedRunnerTimeouts | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `DeleteInput`Optional + +```csharp +public string DeleteInput { get; } +``` + +- *Type:* string + +--- + +##### `Delete`Required + +```csharp +public string Delete { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|ActionsHostedRunnerTimeouts InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|ActionsHostedRunnerTimeouts + +--- + + + diff --git a/docs/actionsHostedRunner.java.md b/docs/actionsHostedRunner.java.md new file mode 100644 index 000000000..079db9d02 --- /dev/null +++ b/docs/actionsHostedRunner.java.md @@ -0,0 +1,3031 @@ +# `actionsHostedRunner` Submodule + +## Constructs + +### ActionsHostedRunner + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner github_actions_hosted_runner}. + +#### Initializers + +```java +import io.cdktn.providers.github.actions_hosted_runner.ActionsHostedRunner; + +ActionsHostedRunner.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .image(ActionsHostedRunnerImage) + .name(java.lang.String) + .runnerGroupId(java.lang.Number) + .size(java.lang.String) +// .imageGen(java.lang.Boolean|IResolvable) +// .imageVersion(java.lang.String) +// .maximumRunners(java.lang.Number) +// .publicIpEnabled(java.lang.Boolean|IResolvable) +// .timeouts(ActionsHostedRunnerTimeouts) + .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 | *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 | *No description.* | +| image | ActionsHostedRunnerImage | image block. | +| name | java.lang.String | Name of the hosted runner. | +| runnerGroupId | java.lang.Number | The runner group ID. | +| size | java.lang.String | Machine size (e.g., '4-core', '8-core'). Can be updated to scale the runner. | +| imageGen | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether this runner should be used to generate custom images. Cannot be changed after creation. | +| imageVersion | java.lang.String | The version of the runner image to deploy. This is relevant only for runners using custom images. | +| maximumRunners | java.lang.Number | Maximum number of runners to scale up to. | +| publicIpEnabled | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether to enable static public IP. | +| timeouts | ActionsHostedRunnerTimeouts | timeouts block. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `image`Required + +- *Type:* ActionsHostedRunnerImage + +image block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#image ActionsHostedRunner#image} + +--- + +##### `name`Required + +- *Type:* java.lang.String + +Name of the hosted runner. + +Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#name ActionsHostedRunner#name} + +--- + +##### `runnerGroupId`Required + +- *Type:* java.lang.Number + +The runner group ID. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#runner_group_id ActionsHostedRunner#runner_group_id} + +--- + +##### `size`Required + +- *Type:* java.lang.String + +Machine size (e.g., '4-core', '8-core'). Can be updated to scale the runner. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#size ActionsHostedRunner#size} + +--- + +##### `imageGen`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether this runner should be used to generate custom images. Cannot be changed after creation. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#image_gen ActionsHostedRunner#image_gen} + +--- + +##### `imageVersion`Optional + +- *Type:* java.lang.String + +The version of the runner image to deploy. This is relevant only for runners using custom images. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#image_version ActionsHostedRunner#image_version} + +--- + +##### `maximumRunners`Optional + +- *Type:* java.lang.Number + +Maximum number of runners to scale up to. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#maximum_runners ActionsHostedRunner#maximum_runners} + +--- + +##### `publicIpEnabled`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether to enable static public IP. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#public_ip_enabled ActionsHostedRunner#public_ip_enabled} + +--- + +##### `timeouts`Optional + +- *Type:* ActionsHostedRunnerTimeouts + +timeouts block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#timeouts ActionsHostedRunner#timeouts} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| putImage | *No description.* | +| putTimeouts | *No description.* | +| resetImageGen | *No description.* | +| resetImageVersion | *No description.* | +| resetMaximumRunners | *No description.* | +| resetPublicIpEnabled | *No description.* | +| resetTimeouts | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `putImage` + +```java +public void putImage(ActionsHostedRunnerImage value) +``` + +###### `value`Required + +- *Type:* ActionsHostedRunnerImage + +--- + +##### `putTimeouts` + +```java +public void putTimeouts(ActionsHostedRunnerTimeouts value) +``` + +###### `value`Required + +- *Type:* ActionsHostedRunnerTimeouts + +--- + +##### `resetImageGen` + +```java +public void resetImageGen() +``` + +##### `resetImageVersion` + +```java +public void resetImageVersion() +``` + +##### `resetMaximumRunners` + +```java +public void resetMaximumRunners() +``` + +##### `resetPublicIpEnabled` + +```java +public void resetPublicIpEnabled() +``` + +##### `resetTimeouts` + +```java +public void resetTimeouts() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a ActionsHostedRunner resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.actions_hosted_runner.ActionsHostedRunner; + +ActionsHostedRunner.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` + +```java +import io.cdktn.providers.github.actions_hosted_runner.ActionsHostedRunner; + +ActionsHostedRunner.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.actions_hosted_runner.ActionsHostedRunner; + +ActionsHostedRunner.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.actions_hosted_runner.ActionsHostedRunner; + +ActionsHostedRunner.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ActionsHostedRunner.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a ActionsHostedRunner 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 ActionsHostedRunner to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing ActionsHostedRunner that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#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 ActionsHostedRunner 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| id | java.lang.String | *No description.* | +| image | ActionsHostedRunnerImageOutputReference | *No description.* | +| lastActiveOn | java.lang.String | *No description.* | +| machineSizeDetails | ActionsHostedRunnerMachineSizeDetailsList | *No description.* | +| platform | java.lang.String | *No description.* | +| publicIps | ActionsHostedRunnerPublicIpsList | *No description.* | +| status | java.lang.String | *No description.* | +| timeouts | ActionsHostedRunnerTimeoutsOutputReference | *No description.* | +| imageGenInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| imageInput | ActionsHostedRunnerImage | *No description.* | +| imageVersionInput | java.lang.String | *No description.* | +| maximumRunnersInput | java.lang.Number | *No description.* | +| nameInput | java.lang.String | *No description.* | +| publicIpEnabledInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| runnerGroupIdInput | java.lang.Number | *No description.* | +| sizeInput | java.lang.String | *No description.* | +| timeoutsInput | io.cdktn.cdktn.IResolvable\|ActionsHostedRunnerTimeouts | *No description.* | +| imageGen | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| imageVersion | java.lang.String | *No description.* | +| maximumRunners | java.lang.Number | *No description.* | +| name | java.lang.String | *No description.* | +| publicIpEnabled | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| runnerGroupId | java.lang.Number | *No description.* | +| size | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `image`Required + +```java +public ActionsHostedRunnerImageOutputReference getImage(); +``` + +- *Type:* ActionsHostedRunnerImageOutputReference + +--- + +##### `lastActiveOn`Required + +```java +public java.lang.String getLastActiveOn(); +``` + +- *Type:* java.lang.String + +--- + +##### `machineSizeDetails`Required + +```java +public ActionsHostedRunnerMachineSizeDetailsList getMachineSizeDetails(); +``` + +- *Type:* ActionsHostedRunnerMachineSizeDetailsList + +--- + +##### `platform`Required + +```java +public java.lang.String getPlatform(); +``` + +- *Type:* java.lang.String + +--- + +##### `publicIps`Required + +```java +public ActionsHostedRunnerPublicIpsList getPublicIps(); +``` + +- *Type:* ActionsHostedRunnerPublicIpsList + +--- + +##### `status`Required + +```java +public java.lang.String getStatus(); +``` + +- *Type:* java.lang.String + +--- + +##### `timeouts`Required + +```java +public ActionsHostedRunnerTimeoutsOutputReference getTimeouts(); +``` + +- *Type:* ActionsHostedRunnerTimeoutsOutputReference + +--- + +##### `imageGenInput`Optional + +```java +public java.lang.Boolean|IResolvable getImageGenInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `imageInput`Optional + +```java +public ActionsHostedRunnerImage getImageInput(); +``` + +- *Type:* ActionsHostedRunnerImage + +--- + +##### `imageVersionInput`Optional + +```java +public java.lang.String getImageVersionInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `maximumRunnersInput`Optional + +```java +public java.lang.Number getMaximumRunnersInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `publicIpEnabledInput`Optional + +```java +public java.lang.Boolean|IResolvable getPublicIpEnabledInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `runnerGroupIdInput`Optional + +```java +public java.lang.Number getRunnerGroupIdInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `sizeInput`Optional + +```java +public java.lang.String getSizeInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `timeoutsInput`Optional + +```java +public IResolvable|ActionsHostedRunnerTimeouts getTimeoutsInput(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|ActionsHostedRunnerTimeouts + +--- + +##### `imageGen`Required + +```java +public java.lang.Boolean|IResolvable getImageGen(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `imageVersion`Required + +```java +public java.lang.String getImageVersion(); +``` + +- *Type:* java.lang.String + +--- + +##### `maximumRunners`Required + +```java +public java.lang.Number getMaximumRunners(); +``` + +- *Type:* java.lang.Number + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `publicIpEnabled`Required + +```java +public java.lang.Boolean|IResolvable getPublicIpEnabled(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `runnerGroupId`Required + +```java +public java.lang.Number getRunnerGroupId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `size`Required + +```java +public java.lang.String getSize(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### ActionsHostedRunnerConfig + +#### Initializer + +```java +import io.cdktn.providers.github.actions_hosted_runner.ActionsHostedRunnerConfig; + +ActionsHostedRunnerConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .image(ActionsHostedRunnerImage) + .name(java.lang.String) + .runnerGroupId(java.lang.Number) + .size(java.lang.String) +// .imageGen(java.lang.Boolean|IResolvable) +// .imageVersion(java.lang.String) +// .maximumRunners(java.lang.Number) +// .publicIpEnabled(java.lang.Boolean|IResolvable) +// .timeouts(ActionsHostedRunnerTimeouts) + .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 | *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 | *No description.* | +| image | ActionsHostedRunnerImage | image block. | +| name | java.lang.String | Name of the hosted runner. | +| runnerGroupId | java.lang.Number | The runner group ID. | +| size | java.lang.String | Machine size (e.g., '4-core', '8-core'). Can be updated to scale the runner. | +| imageGen | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether this runner should be used to generate custom images. Cannot be changed after creation. | +| imageVersion | java.lang.String | The version of the runner image to deploy. This is relevant only for runners using custom images. | +| maximumRunners | java.lang.Number | Maximum number of runners to scale up to. | +| publicIpEnabled | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether to enable static public IP. | +| timeouts | ActionsHostedRunnerTimeouts | timeouts block. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `image`Required + +```java +public ActionsHostedRunnerImage getImage(); +``` + +- *Type:* ActionsHostedRunnerImage + +image block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#image ActionsHostedRunner#image} + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +Name of the hosted runner. + +Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#name ActionsHostedRunner#name} + +--- + +##### `runnerGroupId`Required + +```java +public java.lang.Number getRunnerGroupId(); +``` + +- *Type:* java.lang.Number + +The runner group ID. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#runner_group_id ActionsHostedRunner#runner_group_id} + +--- + +##### `size`Required + +```java +public java.lang.String getSize(); +``` + +- *Type:* java.lang.String + +Machine size (e.g., '4-core', '8-core'). Can be updated to scale the runner. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#size ActionsHostedRunner#size} + +--- + +##### `imageGen`Optional + +```java +public java.lang.Boolean|IResolvable getImageGen(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether this runner should be used to generate custom images. Cannot be changed after creation. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#image_gen ActionsHostedRunner#image_gen} + +--- + +##### `imageVersion`Optional + +```java +public java.lang.String getImageVersion(); +``` + +- *Type:* java.lang.String + +The version of the runner image to deploy. This is relevant only for runners using custom images. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#image_version ActionsHostedRunner#image_version} + +--- + +##### `maximumRunners`Optional + +```java +public java.lang.Number getMaximumRunners(); +``` + +- *Type:* java.lang.Number + +Maximum number of runners to scale up to. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#maximum_runners ActionsHostedRunner#maximum_runners} + +--- + +##### `publicIpEnabled`Optional + +```java +public java.lang.Boolean|IResolvable getPublicIpEnabled(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether to enable static public IP. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#public_ip_enabled ActionsHostedRunner#public_ip_enabled} + +--- + +##### `timeouts`Optional + +```java +public ActionsHostedRunnerTimeouts getTimeouts(); +``` + +- *Type:* ActionsHostedRunnerTimeouts + +timeouts block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#timeouts ActionsHostedRunner#timeouts} + +--- + +### ActionsHostedRunnerImage + +#### Initializer + +```java +import io.cdktn.providers.github.actions_hosted_runner.ActionsHostedRunnerImage; + +ActionsHostedRunnerImage.builder() + .id(java.lang.String) +// .source(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| id | java.lang.String | The image ID. | +| source | java.lang.String | The image source (github, partner, or custom). | + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +The image ID. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#id ActionsHostedRunner#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. + +--- + +##### `source`Optional + +```java +public java.lang.String getSource(); +``` + +- *Type:* java.lang.String + +The image source (github, partner, or custom). + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#source ActionsHostedRunner#source} + +--- + +### ActionsHostedRunnerMachineSizeDetails + +#### Initializer + +```java +import io.cdktn.providers.github.actions_hosted_runner.ActionsHostedRunnerMachineSizeDetails; + +ActionsHostedRunnerMachineSizeDetails.builder() + .build(); +``` + + +### ActionsHostedRunnerPublicIps + +#### Initializer + +```java +import io.cdktn.providers.github.actions_hosted_runner.ActionsHostedRunnerPublicIps; + +ActionsHostedRunnerPublicIps.builder() + .build(); +``` + + +### ActionsHostedRunnerTimeouts + +#### Initializer + +```java +import io.cdktn.providers.github.actions_hosted_runner.ActionsHostedRunnerTimeouts; + +ActionsHostedRunnerTimeouts.builder() +// .delete(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| delete | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#delete ActionsHostedRunner#delete}. | + +--- + +##### `delete`Optional + +```java +public java.lang.String getDelete(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_hosted_runner#delete ActionsHostedRunner#delete}. + +--- + +## Classes + +### ActionsHostedRunnerImageOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.actions_hosted_runner.ActionsHostedRunnerImageOutputReference; + +new ActionsHostedRunnerImageOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetSource | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetSource` + +```java +public void resetSource() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| sizeGb | java.lang.Number | *No description.* | +| idInput | java.lang.String | *No description.* | +| sourceInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| source | java.lang.String | *No description.* | +| internalValue | ActionsHostedRunnerImage | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `sizeGb`Required + +```java +public java.lang.Number getSizeGb(); +``` + +- *Type:* java.lang.Number + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `sourceInput`Optional + +```java +public java.lang.String getSourceInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `source`Required + +```java +public java.lang.String getSource(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public ActionsHostedRunnerImage getInternalValue(); +``` + +- *Type:* ActionsHostedRunnerImage + +--- + + +### ActionsHostedRunnerMachineSizeDetailsList + +#### Initializers + +```java +import io.cdktn.providers.github.actions_hosted_runner.ActionsHostedRunnerMachineSizeDetailsList; + +new ActionsHostedRunnerMachineSizeDetailsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public ActionsHostedRunnerMachineSizeDetailsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### ActionsHostedRunnerMachineSizeDetailsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.actions_hosted_runner.ActionsHostedRunnerMachineSizeDetailsOutputReference; + +new ActionsHostedRunnerMachineSizeDetailsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| cpuCores | java.lang.Number | *No description.* | +| id | java.lang.String | *No description.* | +| memoryGb | java.lang.Number | *No description.* | +| storageGb | java.lang.Number | *No description.* | +| internalValue | ActionsHostedRunnerMachineSizeDetails | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `cpuCores`Required + +```java +public java.lang.Number getCpuCores(); +``` + +- *Type:* java.lang.Number + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `memoryGb`Required + +```java +public java.lang.Number getMemoryGb(); +``` + +- *Type:* java.lang.Number + +--- + +##### `storageGb`Required + +```java +public java.lang.Number getStorageGb(); +``` + +- *Type:* java.lang.Number + +--- + +##### `internalValue`Optional + +```java +public ActionsHostedRunnerMachineSizeDetails getInternalValue(); +``` + +- *Type:* ActionsHostedRunnerMachineSizeDetails + +--- + + +### ActionsHostedRunnerPublicIpsList + +#### Initializers + +```java +import io.cdktn.providers.github.actions_hosted_runner.ActionsHostedRunnerPublicIpsList; + +new ActionsHostedRunnerPublicIpsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public ActionsHostedRunnerPublicIpsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### ActionsHostedRunnerPublicIpsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.actions_hosted_runner.ActionsHostedRunnerPublicIpsOutputReference; + +new ActionsHostedRunnerPublicIpsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| enabled | io.cdktn.cdktn.IResolvable | *No description.* | +| length | java.lang.Number | *No description.* | +| prefix | java.lang.String | *No description.* | +| internalValue | ActionsHostedRunnerPublicIps | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `enabled`Required + +```java +public IResolvable getEnabled(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `length`Required + +```java +public java.lang.Number getLength(); +``` + +- *Type:* java.lang.Number + +--- + +##### `prefix`Required + +```java +public java.lang.String getPrefix(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public ActionsHostedRunnerPublicIps getInternalValue(); +``` + +- *Type:* ActionsHostedRunnerPublicIps + +--- + + +### ActionsHostedRunnerTimeoutsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.actions_hosted_runner.ActionsHostedRunnerTimeoutsOutputReference; + +new ActionsHostedRunnerTimeoutsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetDelete | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetDelete` + +```java +public void resetDelete() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| deleteInput | java.lang.String | *No description.* | +| delete | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|ActionsHostedRunnerTimeouts | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `deleteInput`Optional + +```java +public java.lang.String getDeleteInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `delete`Required + +```java +public java.lang.String getDelete(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|ActionsHostedRunnerTimeouts getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|ActionsHostedRunnerTimeouts + +--- + + + diff --git a/docs/actionsOrganizationOidcSubjectClaimCustomizationTemplate.csharp.md b/docs/actionsOrganizationOidcSubjectClaimCustomizationTemplate.csharp.md new file mode 100644 index 000000000..c8c089ed8 --- /dev/null +++ b/docs/actionsOrganizationOidcSubjectClaimCustomizationTemplate.csharp.md @@ -0,0 +1,874 @@ +# `actionsOrganizationOidcSubjectClaimCustomizationTemplate` Submodule + +## Constructs + +### ActionsOrganizationOidcSubjectClaimCustomizationTemplate + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_oidc_subject_claim_customization_template github_actions_organization_oidc_subject_claim_customization_template}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsOrganizationOidcSubjectClaimCustomizationTemplate(Construct Scope, string Id, ActionsOrganizationOidcSubjectClaimCustomizationTemplateConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | ActionsOrganizationOidcSubjectClaimCustomizationTemplateConfig | *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:* ActionsOrganizationOidcSubjectClaimCustomizationTemplateConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a ActionsOrganizationOidcSubjectClaimCustomizationTemplate resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationOidcSubjectClaimCustomizationTemplate.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` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationOidcSubjectClaimCustomizationTemplate.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationOidcSubjectClaimCustomizationTemplate.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationOidcSubjectClaimCustomizationTemplate.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a ActionsOrganizationOidcSubjectClaimCustomizationTemplate resource upon running "cdktn 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 ActionsOrganizationOidcSubjectClaimCustomizationTemplate to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing ActionsOrganizationOidcSubjectClaimCustomizationTemplate that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_oidc_subject_claim_customization_template#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the ActionsOrganizationOidcSubjectClaimCustomizationTemplate to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| IdInput | string | *No description.* | +| IncludeClaimKeysInput | string[] | *No description.* | +| Id | string | *No description.* | +| IncludeClaimKeys | string[] | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `IncludeClaimKeysInput`Optional + +```csharp +public string[] IncludeClaimKeysInput { get; } +``` + +- *Type:* string[] + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `IncludeClaimKeys`Required + +```csharp +public string[] IncludeClaimKeys { get; } +``` + +- *Type:* string[] + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### ActionsOrganizationOidcSubjectClaimCustomizationTemplateConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsOrganizationOidcSubjectClaimCustomizationTemplateConfig { + 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[] IncludeClaimKeys, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| IncludeClaimKeys | string[] | A list of OpenID Connect claims. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_oidc_subject_claim_customization_template#id ActionsOrganizationOidcSubjectClaimCustomizationTemplate#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `IncludeClaimKeys`Required + +```csharp +public string[] IncludeClaimKeys { get; set; } +``` + +- *Type:* string[] + +A list of OpenID Connect claims. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_oidc_subject_claim_customization_template#include_claim_keys ActionsOrganizationOidcSubjectClaimCustomizationTemplate#include_claim_keys} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_oidc_subject_claim_customization_template#id ActionsOrganizationOidcSubjectClaimCustomizationTemplate#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. + +--- + + + diff --git a/docs/actionsOrganizationOidcSubjectClaimCustomizationTemplate.java.md b/docs/actionsOrganizationOidcSubjectClaimCustomizationTemplate.java.md new file mode 100644 index 000000000..7a5699780 --- /dev/null +++ b/docs/actionsOrganizationOidcSubjectClaimCustomizationTemplate.java.md @@ -0,0 +1,951 @@ +# `actionsOrganizationOidcSubjectClaimCustomizationTemplate` Submodule + +## Constructs + +### ActionsOrganizationOidcSubjectClaimCustomizationTemplate + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_oidc_subject_claim_customization_template github_actions_organization_oidc_subject_claim_customization_template}. + +#### Initializers + +```java +import io.cdktn.providers.github.actions_organization_oidc_subject_claim_customization_template.ActionsOrganizationOidcSubjectClaimCustomizationTemplate; + +ActionsOrganizationOidcSubjectClaimCustomizationTemplate.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .includeClaimKeys(java.util.List) +// .id(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 | *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 | *No description.* | +| includeClaimKeys | java.util.List | A list of OpenID Connect claims. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_oidc_subject_claim_customization_template#id ActionsOrganizationOidcSubjectClaimCustomizationTemplate#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `includeClaimKeys`Required + +- *Type:* java.util.List + +A list of OpenID Connect claims. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_oidc_subject_claim_customization_template#include_claim_keys ActionsOrganizationOidcSubjectClaimCustomizationTemplate#include_claim_keys} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_oidc_subject_claim_customization_template#id ActionsOrganizationOidcSubjectClaimCustomizationTemplate#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a ActionsOrganizationOidcSubjectClaimCustomizationTemplate resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.actions_organization_oidc_subject_claim_customization_template.ActionsOrganizationOidcSubjectClaimCustomizationTemplate; + +ActionsOrganizationOidcSubjectClaimCustomizationTemplate.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` + +```java +import io.cdktn.providers.github.actions_organization_oidc_subject_claim_customization_template.ActionsOrganizationOidcSubjectClaimCustomizationTemplate; + +ActionsOrganizationOidcSubjectClaimCustomizationTemplate.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.actions_organization_oidc_subject_claim_customization_template.ActionsOrganizationOidcSubjectClaimCustomizationTemplate; + +ActionsOrganizationOidcSubjectClaimCustomizationTemplate.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.actions_organization_oidc_subject_claim_customization_template.ActionsOrganizationOidcSubjectClaimCustomizationTemplate; + +ActionsOrganizationOidcSubjectClaimCustomizationTemplate.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ActionsOrganizationOidcSubjectClaimCustomizationTemplate.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a ActionsOrganizationOidcSubjectClaimCustomizationTemplate 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 ActionsOrganizationOidcSubjectClaimCustomizationTemplate to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing ActionsOrganizationOidcSubjectClaimCustomizationTemplate that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_oidc_subject_claim_customization_template#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 ActionsOrganizationOidcSubjectClaimCustomizationTemplate 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| idInput | java.lang.String | *No description.* | +| includeClaimKeysInput | java.util.List | *No description.* | +| id | java.lang.String | *No description.* | +| includeClaimKeys | java.util.List | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `includeClaimKeysInput`Optional + +```java +public java.util.List getIncludeClaimKeysInput(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `includeClaimKeys`Required + +```java +public java.util.List getIncludeClaimKeys(); +``` + +- *Type:* java.util.List + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### ActionsOrganizationOidcSubjectClaimCustomizationTemplateConfig + +#### Initializer + +```java +import io.cdktn.providers.github.actions_organization_oidc_subject_claim_customization_template.ActionsOrganizationOidcSubjectClaimCustomizationTemplateConfig; + +ActionsOrganizationOidcSubjectClaimCustomizationTemplateConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .includeClaimKeys(java.util.List) +// .id(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 | *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 | *No description.* | +| includeClaimKeys | java.util.List | A list of OpenID Connect claims. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_oidc_subject_claim_customization_template#id ActionsOrganizationOidcSubjectClaimCustomizationTemplate#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `includeClaimKeys`Required + +```java +public java.util.List getIncludeClaimKeys(); +``` + +- *Type:* java.util.List + +A list of OpenID Connect claims. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_oidc_subject_claim_customization_template#include_claim_keys ActionsOrganizationOidcSubjectClaimCustomizationTemplate#include_claim_keys} + +--- + +##### `id`Optional + +```java +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/resources/actions_organization_oidc_subject_claim_customization_template#id ActionsOrganizationOidcSubjectClaimCustomizationTemplate#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. + +--- + + + diff --git a/docs/actionsOrganizationPermissions.csharp.md b/docs/actionsOrganizationPermissions.csharp.md new file mode 100644 index 000000000..72e969e73 --- /dev/null +++ b/docs/actionsOrganizationPermissions.csharp.md @@ -0,0 +1,1789 @@ +# `actionsOrganizationPermissions` Submodule + +## Constructs + +### ActionsOrganizationPermissions + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions github_actions_organization_permissions}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsOrganizationPermissions(Construct Scope, string Id, ActionsOrganizationPermissionsConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | ActionsOrganizationPermissionsConfig | *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:* ActionsOrganizationPermissionsConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| PutAllowedActionsConfig | *No description.* | +| PutEnabledRepositoriesConfig | *No description.* | +| ResetAllowedActions | *No description.* | +| ResetAllowedActionsConfig | *No description.* | +| ResetEnabledRepositoriesConfig | *No description.* | +| ResetId | *No description.* | +| ResetShaPinningRequired | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `PutAllowedActionsConfig` + +```csharp +private void PutAllowedActionsConfig(ActionsOrganizationPermissionsAllowedActionsConfig Value) +``` + +###### `Value`Required + +- *Type:* ActionsOrganizationPermissionsAllowedActionsConfig + +--- + +##### `PutEnabledRepositoriesConfig` + +```csharp +private void PutEnabledRepositoriesConfig(ActionsOrganizationPermissionsEnabledRepositoriesConfig Value) +``` + +###### `Value`Required + +- *Type:* ActionsOrganizationPermissionsEnabledRepositoriesConfig + +--- + +##### `ResetAllowedActions` + +```csharp +private void ResetAllowedActions() +``` + +##### `ResetAllowedActionsConfig` + +```csharp +private void ResetAllowedActionsConfig() +``` + +##### `ResetEnabledRepositoriesConfig` + +```csharp +private void ResetEnabledRepositoriesConfig() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetShaPinningRequired` + +```csharp +private void ResetShaPinningRequired() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a ActionsOrganizationPermissions resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationPermissions.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` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationPermissions.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationPermissions.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationPermissions.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a ActionsOrganizationPermissions resource upon running "cdktn 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 ActionsOrganizationPermissions to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing ActionsOrganizationPermissions that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the ActionsOrganizationPermissions to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| AllowedActionsConfig | ActionsOrganizationPermissionsAllowedActionsConfigOutputReference | *No description.* | +| EnabledRepositoriesConfig | ActionsOrganizationPermissionsEnabledRepositoriesConfigOutputReference | *No description.* | +| AllowedActionsConfigInput | ActionsOrganizationPermissionsAllowedActionsConfig | *No description.* | +| AllowedActionsInput | string | *No description.* | +| EnabledRepositoriesConfigInput | ActionsOrganizationPermissionsEnabledRepositoriesConfig | *No description.* | +| EnabledRepositoriesInput | string | *No description.* | +| IdInput | string | *No description.* | +| ShaPinningRequiredInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| AllowedActions | string | *No description.* | +| EnabledRepositories | string | *No description.* | +| Id | string | *No description.* | +| ShaPinningRequired | bool\|Io.Cdktn.IResolvable | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `AllowedActionsConfig`Required + +```csharp +public ActionsOrganizationPermissionsAllowedActionsConfigOutputReference AllowedActionsConfig { get; } +``` + +- *Type:* ActionsOrganizationPermissionsAllowedActionsConfigOutputReference + +--- + +##### `EnabledRepositoriesConfig`Required + +```csharp +public ActionsOrganizationPermissionsEnabledRepositoriesConfigOutputReference EnabledRepositoriesConfig { get; } +``` + +- *Type:* ActionsOrganizationPermissionsEnabledRepositoriesConfigOutputReference + +--- + +##### `AllowedActionsConfigInput`Optional + +```csharp +public ActionsOrganizationPermissionsAllowedActionsConfig AllowedActionsConfigInput { get; } +``` + +- *Type:* ActionsOrganizationPermissionsAllowedActionsConfig + +--- + +##### `AllowedActionsInput`Optional + +```csharp +public string AllowedActionsInput { get; } +``` + +- *Type:* string + +--- + +##### `EnabledRepositoriesConfigInput`Optional + +```csharp +public ActionsOrganizationPermissionsEnabledRepositoriesConfig EnabledRepositoriesConfigInput { get; } +``` + +- *Type:* ActionsOrganizationPermissionsEnabledRepositoriesConfig + +--- + +##### `EnabledRepositoriesInput`Optional + +```csharp +public string EnabledRepositoriesInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `ShaPinningRequiredInput`Optional + +```csharp +public bool|IResolvable ShaPinningRequiredInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `AllowedActions`Required + +```csharp +public string AllowedActions { get; } +``` + +- *Type:* string + +--- + +##### `EnabledRepositories`Required + +```csharp +public string EnabledRepositories { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `ShaPinningRequired`Required + +```csharp +public bool|IResolvable ShaPinningRequired { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### ActionsOrganizationPermissionsAllowedActionsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsOrganizationPermissionsAllowedActionsConfig { + bool|IResolvable GithubOwnedAllowed, + string[] PatternsAllowed = null, + bool|IResolvable VerifiedAllowed = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GithubOwnedAllowed | bool\|Io.Cdktn.IResolvable | Whether GitHub-owned actions are allowed in the organization. | +| PatternsAllowed | string[] | Specifies a list of string-matching patterns to allow specific action(s). | +| VerifiedAllowed | bool\|Io.Cdktn.IResolvable | Whether actions in GitHub Marketplace from verified creators are allowed. | + +--- + +##### `GithubOwnedAllowed`Required + +```csharp +public bool|IResolvable GithubOwnedAllowed { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether GitHub-owned actions are allowed in the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#github_owned_allowed ActionsOrganizationPermissions#github_owned_allowed} + +--- + +##### `PatternsAllowed`Optional + +```csharp +public string[] PatternsAllowed { get; set; } +``` + +- *Type:* string[] + +Specifies a list of string-matching patterns to allow specific action(s). + +Wildcards, tags, and SHAs are allowed. For example, 'monalisa/octocat@', 'monalisa/octocat@v2', 'monalisa/'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#patterns_allowed ActionsOrganizationPermissions#patterns_allowed} + +--- + +##### `VerifiedAllowed`Optional + +```csharp +public bool|IResolvable VerifiedAllowed { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether actions in GitHub Marketplace from verified creators are allowed. + +Set to 'true' to allow all GitHub Marketplace actions by verified creators. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#verified_allowed ActionsOrganizationPermissions#verified_allowed} + +--- + +### ActionsOrganizationPermissionsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsOrganizationPermissionsConfig { + 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 EnabledRepositories, + string AllowedActions = null, + ActionsOrganizationPermissionsAllowedActionsConfig AllowedActionsConfig = null, + ActionsOrganizationPermissionsEnabledRepositoriesConfig EnabledRepositoriesConfig = null, + string Id = null, + bool|IResolvable ShaPinningRequired = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| EnabledRepositories | string | The policy that controls the repositories in the organization that are allowed to run GitHub Actions. | +| AllowedActions | string | The permissions policy that controls the actions that are allowed to run. | +| AllowedActionsConfig | ActionsOrganizationPermissionsAllowedActionsConfig | allowed_actions_config block. | +| EnabledRepositoriesConfig | ActionsOrganizationPermissionsEnabledRepositoriesConfig | enabled_repositories_config block. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#id ActionsOrganizationPermissions#id}. | +| ShaPinningRequired | bool\|Io.Cdktn.IResolvable | Whether pinning to a specific SHA is required for all actions and reusable workflows in an organization. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `EnabledRepositories`Required + +```csharp +public string EnabledRepositories { get; set; } +``` + +- *Type:* string + +The policy that controls the repositories in the organization that are allowed to run GitHub Actions. + +Can be one of: 'all', 'none', or 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#enabled_repositories ActionsOrganizationPermissions#enabled_repositories} + +--- + +##### `AllowedActions`Optional + +```csharp +public string AllowedActions { get; set; } +``` + +- *Type:* string + +The permissions policy that controls the actions that are allowed to run. + +Can be one of: 'all', 'local_only', or 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#allowed_actions ActionsOrganizationPermissions#allowed_actions} + +--- + +##### `AllowedActionsConfig`Optional + +```csharp +public ActionsOrganizationPermissionsAllowedActionsConfig AllowedActionsConfig { get; set; } +``` + +- *Type:* ActionsOrganizationPermissionsAllowedActionsConfig + +allowed_actions_config block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#allowed_actions_config ActionsOrganizationPermissions#allowed_actions_config} + +--- + +##### `EnabledRepositoriesConfig`Optional + +```csharp +public ActionsOrganizationPermissionsEnabledRepositoriesConfig EnabledRepositoriesConfig { get; set; } +``` + +- *Type:* ActionsOrganizationPermissionsEnabledRepositoriesConfig + +enabled_repositories_config block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#enabled_repositories_config ActionsOrganizationPermissions#enabled_repositories_config} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#id ActionsOrganizationPermissions#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. + +--- + +##### `ShaPinningRequired`Optional + +```csharp +public bool|IResolvable ShaPinningRequired { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether pinning to a specific SHA is required for all actions and reusable workflows in an organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#sha_pinning_required ActionsOrganizationPermissions#sha_pinning_required} + +--- + +### ActionsOrganizationPermissionsEnabledRepositoriesConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsOrganizationPermissionsEnabledRepositoriesConfig { + double[] RepositoryIds +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| RepositoryIds | double[] | List of repository IDs to enable for GitHub Actions. | + +--- + +##### `RepositoryIds`Required + +```csharp +public double[] RepositoryIds { get; set; } +``` + +- *Type:* double[] + +List of repository IDs to enable for GitHub Actions. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#repository_ids ActionsOrganizationPermissions#repository_ids} + +--- + +## Classes + +### ActionsOrganizationPermissionsAllowedActionsConfigOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsOrganizationPermissionsAllowedActionsConfigOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetPatternsAllowed | *No description.* | +| ResetVerifiedAllowed | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetPatternsAllowed` + +```csharp +private void ResetPatternsAllowed() +``` + +##### `ResetVerifiedAllowed` + +```csharp +private void ResetVerifiedAllowed() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| GithubOwnedAllowedInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| PatternsAllowedInput | string[] | *No description.* | +| VerifiedAllowedInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| GithubOwnedAllowed | bool\|Io.Cdktn.IResolvable | *No description.* | +| PatternsAllowed | string[] | *No description.* | +| VerifiedAllowed | bool\|Io.Cdktn.IResolvable | *No description.* | +| InternalValue | ActionsOrganizationPermissionsAllowedActionsConfig | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `GithubOwnedAllowedInput`Optional + +```csharp +public bool|IResolvable GithubOwnedAllowedInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `PatternsAllowedInput`Optional + +```csharp +public string[] PatternsAllowedInput { get; } +``` + +- *Type:* string[] + +--- + +##### `VerifiedAllowedInput`Optional + +```csharp +public bool|IResolvable VerifiedAllowedInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `GithubOwnedAllowed`Required + +```csharp +public bool|IResolvable GithubOwnedAllowed { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `PatternsAllowed`Required + +```csharp +public string[] PatternsAllowed { get; } +``` + +- *Type:* string[] + +--- + +##### `VerifiedAllowed`Required + +```csharp +public bool|IResolvable VerifiedAllowed { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `InternalValue`Optional + +```csharp +public ActionsOrganizationPermissionsAllowedActionsConfig InternalValue { get; } +``` + +- *Type:* ActionsOrganizationPermissionsAllowedActionsConfig + +--- + + +### ActionsOrganizationPermissionsEnabledRepositoriesConfigOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsOrganizationPermissionsEnabledRepositoriesConfigOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| RepositoryIdsInput | double[] | *No description.* | +| RepositoryIds | double[] | *No description.* | +| InternalValue | ActionsOrganizationPermissionsEnabledRepositoriesConfig | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryIdsInput`Optional + +```csharp +public double[] RepositoryIdsInput { get; } +``` + +- *Type:* double[] + +--- + +##### `RepositoryIds`Required + +```csharp +public double[] RepositoryIds { get; } +``` + +- *Type:* double[] + +--- + +##### `InternalValue`Optional + +```csharp +public ActionsOrganizationPermissionsEnabledRepositoriesConfig InternalValue { get; } +``` + +- *Type:* ActionsOrganizationPermissionsEnabledRepositoriesConfig + +--- + + + diff --git a/docs/actionsOrganizationPermissions.java.md b/docs/actionsOrganizationPermissions.java.md new file mode 100644 index 000000000..558718a99 --- /dev/null +++ b/docs/actionsOrganizationPermissions.java.md @@ -0,0 +1,1918 @@ +# `actionsOrganizationPermissions` Submodule + +## Constructs + +### ActionsOrganizationPermissions + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions github_actions_organization_permissions}. + +#### Initializers + +```java +import io.cdktn.providers.github.actions_organization_permissions.ActionsOrganizationPermissions; + +ActionsOrganizationPermissions.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .enabledRepositories(java.lang.String) +// .allowedActions(java.lang.String) +// .allowedActionsConfig(ActionsOrganizationPermissionsAllowedActionsConfig) +// .enabledRepositoriesConfig(ActionsOrganizationPermissionsEnabledRepositoriesConfig) +// .id(java.lang.String) +// .shaPinningRequired(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 | *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 | *No description.* | +| enabledRepositories | java.lang.String | The policy that controls the repositories in the organization that are allowed to run GitHub Actions. | +| allowedActions | java.lang.String | The permissions policy that controls the actions that are allowed to run. | +| allowedActionsConfig | ActionsOrganizationPermissionsAllowedActionsConfig | allowed_actions_config block. | +| enabledRepositoriesConfig | ActionsOrganizationPermissionsEnabledRepositoriesConfig | enabled_repositories_config block. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#id ActionsOrganizationPermissions#id}. | +| shaPinningRequired | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether pinning to a specific SHA is required for all actions and reusable workflows in an organization. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `enabledRepositories`Required + +- *Type:* java.lang.String + +The policy that controls the repositories in the organization that are allowed to run GitHub Actions. + +Can be one of: 'all', 'none', or 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#enabled_repositories ActionsOrganizationPermissions#enabled_repositories} + +--- + +##### `allowedActions`Optional + +- *Type:* java.lang.String + +The permissions policy that controls the actions that are allowed to run. + +Can be one of: 'all', 'local_only', or 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#allowed_actions ActionsOrganizationPermissions#allowed_actions} + +--- + +##### `allowedActionsConfig`Optional + +- *Type:* ActionsOrganizationPermissionsAllowedActionsConfig + +allowed_actions_config block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#allowed_actions_config ActionsOrganizationPermissions#allowed_actions_config} + +--- + +##### `enabledRepositoriesConfig`Optional + +- *Type:* ActionsOrganizationPermissionsEnabledRepositoriesConfig + +enabled_repositories_config block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#enabled_repositories_config ActionsOrganizationPermissions#enabled_repositories_config} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#id ActionsOrganizationPermissions#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. + +--- + +##### `shaPinningRequired`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether pinning to a specific SHA is required for all actions and reusable workflows in an organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#sha_pinning_required ActionsOrganizationPermissions#sha_pinning_required} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| putAllowedActionsConfig | *No description.* | +| putEnabledRepositoriesConfig | *No description.* | +| resetAllowedActions | *No description.* | +| resetAllowedActionsConfig | *No description.* | +| resetEnabledRepositoriesConfig | *No description.* | +| resetId | *No description.* | +| resetShaPinningRequired | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `putAllowedActionsConfig` + +```java +public void putAllowedActionsConfig(ActionsOrganizationPermissionsAllowedActionsConfig value) +``` + +###### `value`Required + +- *Type:* ActionsOrganizationPermissionsAllowedActionsConfig + +--- + +##### `putEnabledRepositoriesConfig` + +```java +public void putEnabledRepositoriesConfig(ActionsOrganizationPermissionsEnabledRepositoriesConfig value) +``` + +###### `value`Required + +- *Type:* ActionsOrganizationPermissionsEnabledRepositoriesConfig + +--- + +##### `resetAllowedActions` + +```java +public void resetAllowedActions() +``` + +##### `resetAllowedActionsConfig` + +```java +public void resetAllowedActionsConfig() +``` + +##### `resetEnabledRepositoriesConfig` + +```java +public void resetEnabledRepositoriesConfig() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetShaPinningRequired` + +```java +public void resetShaPinningRequired() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a ActionsOrganizationPermissions resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.actions_organization_permissions.ActionsOrganizationPermissions; + +ActionsOrganizationPermissions.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` + +```java +import io.cdktn.providers.github.actions_organization_permissions.ActionsOrganizationPermissions; + +ActionsOrganizationPermissions.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.actions_organization_permissions.ActionsOrganizationPermissions; + +ActionsOrganizationPermissions.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.actions_organization_permissions.ActionsOrganizationPermissions; + +ActionsOrganizationPermissions.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ActionsOrganizationPermissions.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a ActionsOrganizationPermissions 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 ActionsOrganizationPermissions to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing ActionsOrganizationPermissions that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#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 ActionsOrganizationPermissions 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| allowedActionsConfig | ActionsOrganizationPermissionsAllowedActionsConfigOutputReference | *No description.* | +| enabledRepositoriesConfig | ActionsOrganizationPermissionsEnabledRepositoriesConfigOutputReference | *No description.* | +| allowedActionsConfigInput | ActionsOrganizationPermissionsAllowedActionsConfig | *No description.* | +| allowedActionsInput | java.lang.String | *No description.* | +| enabledRepositoriesConfigInput | ActionsOrganizationPermissionsEnabledRepositoriesConfig | *No description.* | +| enabledRepositoriesInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| shaPinningRequiredInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| allowedActions | java.lang.String | *No description.* | +| enabledRepositories | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| shaPinningRequired | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `allowedActionsConfig`Required + +```java +public ActionsOrganizationPermissionsAllowedActionsConfigOutputReference getAllowedActionsConfig(); +``` + +- *Type:* ActionsOrganizationPermissionsAllowedActionsConfigOutputReference + +--- + +##### `enabledRepositoriesConfig`Required + +```java +public ActionsOrganizationPermissionsEnabledRepositoriesConfigOutputReference getEnabledRepositoriesConfig(); +``` + +- *Type:* ActionsOrganizationPermissionsEnabledRepositoriesConfigOutputReference + +--- + +##### `allowedActionsConfigInput`Optional + +```java +public ActionsOrganizationPermissionsAllowedActionsConfig getAllowedActionsConfigInput(); +``` + +- *Type:* ActionsOrganizationPermissionsAllowedActionsConfig + +--- + +##### `allowedActionsInput`Optional + +```java +public java.lang.String getAllowedActionsInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `enabledRepositoriesConfigInput`Optional + +```java +public ActionsOrganizationPermissionsEnabledRepositoriesConfig getEnabledRepositoriesConfigInput(); +``` + +- *Type:* ActionsOrganizationPermissionsEnabledRepositoriesConfig + +--- + +##### `enabledRepositoriesInput`Optional + +```java +public java.lang.String getEnabledRepositoriesInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `shaPinningRequiredInput`Optional + +```java +public java.lang.Boolean|IResolvable getShaPinningRequiredInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `allowedActions`Required + +```java +public java.lang.String getAllowedActions(); +``` + +- *Type:* java.lang.String + +--- + +##### `enabledRepositories`Required + +```java +public java.lang.String getEnabledRepositories(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `shaPinningRequired`Required + +```java +public java.lang.Boolean|IResolvable getShaPinningRequired(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### ActionsOrganizationPermissionsAllowedActionsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.actions_organization_permissions.ActionsOrganizationPermissionsAllowedActionsConfig; + +ActionsOrganizationPermissionsAllowedActionsConfig.builder() + .githubOwnedAllowed(java.lang.Boolean|IResolvable) +// .patternsAllowed(java.util.List) +// .verifiedAllowed(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| githubOwnedAllowed | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether GitHub-owned actions are allowed in the organization. | +| patternsAllowed | java.util.List | Specifies a list of string-matching patterns to allow specific action(s). | +| verifiedAllowed | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether actions in GitHub Marketplace from verified creators are allowed. | + +--- + +##### `githubOwnedAllowed`Required + +```java +public java.lang.Boolean|IResolvable getGithubOwnedAllowed(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether GitHub-owned actions are allowed in the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#github_owned_allowed ActionsOrganizationPermissions#github_owned_allowed} + +--- + +##### `patternsAllowed`Optional + +```java +public java.util.List getPatternsAllowed(); +``` + +- *Type:* java.util.List + +Specifies a list of string-matching patterns to allow specific action(s). + +Wildcards, tags, and SHAs are allowed. For example, 'monalisa/octocat@', 'monalisa/octocat@v2', 'monalisa/'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#patterns_allowed ActionsOrganizationPermissions#patterns_allowed} + +--- + +##### `verifiedAllowed`Optional + +```java +public java.lang.Boolean|IResolvable getVerifiedAllowed(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether actions in GitHub Marketplace from verified creators are allowed. + +Set to 'true' to allow all GitHub Marketplace actions by verified creators. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#verified_allowed ActionsOrganizationPermissions#verified_allowed} + +--- + +### ActionsOrganizationPermissionsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.actions_organization_permissions.ActionsOrganizationPermissionsConfig; + +ActionsOrganizationPermissionsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .enabledRepositories(java.lang.String) +// .allowedActions(java.lang.String) +// .allowedActionsConfig(ActionsOrganizationPermissionsAllowedActionsConfig) +// .enabledRepositoriesConfig(ActionsOrganizationPermissionsEnabledRepositoriesConfig) +// .id(java.lang.String) +// .shaPinningRequired(java.lang.Boolean|IResolvable) + .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 | *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 | *No description.* | +| enabledRepositories | java.lang.String | The policy that controls the repositories in the organization that are allowed to run GitHub Actions. | +| allowedActions | java.lang.String | The permissions policy that controls the actions that are allowed to run. | +| allowedActionsConfig | ActionsOrganizationPermissionsAllowedActionsConfig | allowed_actions_config block. | +| enabledRepositoriesConfig | ActionsOrganizationPermissionsEnabledRepositoriesConfig | enabled_repositories_config block. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#id ActionsOrganizationPermissions#id}. | +| shaPinningRequired | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether pinning to a specific SHA is required for all actions and reusable workflows in an organization. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `enabledRepositories`Required + +```java +public java.lang.String getEnabledRepositories(); +``` + +- *Type:* java.lang.String + +The policy that controls the repositories in the organization that are allowed to run GitHub Actions. + +Can be one of: 'all', 'none', or 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#enabled_repositories ActionsOrganizationPermissions#enabled_repositories} + +--- + +##### `allowedActions`Optional + +```java +public java.lang.String getAllowedActions(); +``` + +- *Type:* java.lang.String + +The permissions policy that controls the actions that are allowed to run. + +Can be one of: 'all', 'local_only', or 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#allowed_actions ActionsOrganizationPermissions#allowed_actions} + +--- + +##### `allowedActionsConfig`Optional + +```java +public ActionsOrganizationPermissionsAllowedActionsConfig getAllowedActionsConfig(); +``` + +- *Type:* ActionsOrganizationPermissionsAllowedActionsConfig + +allowed_actions_config block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#allowed_actions_config ActionsOrganizationPermissions#allowed_actions_config} + +--- + +##### `enabledRepositoriesConfig`Optional + +```java +public ActionsOrganizationPermissionsEnabledRepositoriesConfig getEnabledRepositoriesConfig(); +``` + +- *Type:* ActionsOrganizationPermissionsEnabledRepositoriesConfig + +enabled_repositories_config block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#enabled_repositories_config ActionsOrganizationPermissions#enabled_repositories_config} + +--- + +##### `id`Optional + +```java +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/resources/actions_organization_permissions#id ActionsOrganizationPermissions#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. + +--- + +##### `shaPinningRequired`Optional + +```java +public java.lang.Boolean|IResolvable getShaPinningRequired(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether pinning to a specific SHA is required for all actions and reusable workflows in an organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#sha_pinning_required ActionsOrganizationPermissions#sha_pinning_required} + +--- + +### ActionsOrganizationPermissionsEnabledRepositoriesConfig + +#### Initializer + +```java +import io.cdktn.providers.github.actions_organization_permissions.ActionsOrganizationPermissionsEnabledRepositoriesConfig; + +ActionsOrganizationPermissionsEnabledRepositoriesConfig.builder() + .repositoryIds(java.util.List) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| repositoryIds | java.util.List | List of repository IDs to enable for GitHub Actions. | + +--- + +##### `repositoryIds`Required + +```java +public java.util.List getRepositoryIds(); +``` + +- *Type:* java.util.List + +List of repository IDs to enable for GitHub Actions. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_permissions#repository_ids ActionsOrganizationPermissions#repository_ids} + +--- + +## Classes + +### ActionsOrganizationPermissionsAllowedActionsConfigOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.actions_organization_permissions.ActionsOrganizationPermissionsAllowedActionsConfigOutputReference; + +new ActionsOrganizationPermissionsAllowedActionsConfigOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetPatternsAllowed | *No description.* | +| resetVerifiedAllowed | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetPatternsAllowed` + +```java +public void resetPatternsAllowed() +``` + +##### `resetVerifiedAllowed` + +```java +public void resetVerifiedAllowed() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| githubOwnedAllowedInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| patternsAllowedInput | java.util.List | *No description.* | +| verifiedAllowedInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| githubOwnedAllowed | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| patternsAllowed | java.util.List | *No description.* | +| verifiedAllowed | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| internalValue | ActionsOrganizationPermissionsAllowedActionsConfig | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `githubOwnedAllowedInput`Optional + +```java +public java.lang.Boolean|IResolvable getGithubOwnedAllowedInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `patternsAllowedInput`Optional + +```java +public java.util.List getPatternsAllowedInput(); +``` + +- *Type:* java.util.List + +--- + +##### `verifiedAllowedInput`Optional + +```java +public java.lang.Boolean|IResolvable getVerifiedAllowedInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `githubOwnedAllowed`Required + +```java +public java.lang.Boolean|IResolvable getGithubOwnedAllowed(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `patternsAllowed`Required + +```java +public java.util.List getPatternsAllowed(); +``` + +- *Type:* java.util.List + +--- + +##### `verifiedAllowed`Required + +```java +public java.lang.Boolean|IResolvable getVerifiedAllowed(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `internalValue`Optional + +```java +public ActionsOrganizationPermissionsAllowedActionsConfig getInternalValue(); +``` + +- *Type:* ActionsOrganizationPermissionsAllowedActionsConfig + +--- + + +### ActionsOrganizationPermissionsEnabledRepositoriesConfigOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.actions_organization_permissions.ActionsOrganizationPermissionsEnabledRepositoriesConfigOutputReference; + +new ActionsOrganizationPermissionsEnabledRepositoriesConfigOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| repositoryIdsInput | java.util.List | *No description.* | +| repositoryIds | java.util.List | *No description.* | +| internalValue | ActionsOrganizationPermissionsEnabledRepositoriesConfig | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryIdsInput`Optional + +```java +public java.util.List getRepositoryIdsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `repositoryIds`Required + +```java +public java.util.List getRepositoryIds(); +``` + +- *Type:* java.util.List + +--- + +##### `internalValue`Optional + +```java +public ActionsOrganizationPermissionsEnabledRepositoriesConfig getInternalValue(); +``` + +- *Type:* ActionsOrganizationPermissionsEnabledRepositoriesConfig + +--- + + + diff --git a/docs/actionsOrganizationSecret.csharp.md b/docs/actionsOrganizationSecret.csharp.md new file mode 100644 index 000000000..df4dbb2aa --- /dev/null +++ b/docs/actionsOrganizationSecret.csharp.md @@ -0,0 +1,1258 @@ +# `actionsOrganizationSecret` Submodule + +## Constructs + +### ActionsOrganizationSecret + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret github_actions_organization_secret}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsOrganizationSecret(Construct Scope, string Id, ActionsOrganizationSecretConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | ActionsOrganizationSecretConfig | *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:* ActionsOrganizationSecretConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetDestroyOnDrift | *No description.* | +| ResetEncryptedValue | *No description.* | +| ResetId | *No description.* | +| ResetKeyId | *No description.* | +| ResetPlaintextValue | *No description.* | +| ResetSelectedRepositoryIds | *No description.* | +| ResetValue | *No description.* | +| ResetValueEncrypted | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetDestroyOnDrift` + +```csharp +private void ResetDestroyOnDrift() +``` + +##### `ResetEncryptedValue` + +```csharp +private void ResetEncryptedValue() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetKeyId` + +```csharp +private void ResetKeyId() +``` + +##### `ResetPlaintextValue` + +```csharp +private void ResetPlaintextValue() +``` + +##### `ResetSelectedRepositoryIds` + +```csharp +private void ResetSelectedRepositoryIds() +``` + +##### `ResetValue` + +```csharp +private void ResetValue() +``` + +##### `ResetValueEncrypted` + +```csharp +private void ResetValueEncrypted() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a ActionsOrganizationSecret resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationSecret.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` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationSecret.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationSecret.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationSecret.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a ActionsOrganizationSecret resource upon running "cdktn 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 ActionsOrganizationSecret to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing ActionsOrganizationSecret that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the ActionsOrganizationSecret to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| CreatedAt | string | *No description.* | +| RemoteUpdatedAt | string | *No description.* | +| UpdatedAt | string | *No description.* | +| DestroyOnDriftInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| EncryptedValueInput | string | *No description.* | +| IdInput | string | *No description.* | +| KeyIdInput | string | *No description.* | +| PlaintextValueInput | string | *No description.* | +| SecretNameInput | string | *No description.* | +| SelectedRepositoryIdsInput | double[] | *No description.* | +| ValueEncryptedInput | string | *No description.* | +| ValueInput | string | *No description.* | +| VisibilityInput | string | *No description.* | +| DestroyOnDrift | bool\|Io.Cdktn.IResolvable | *No description.* | +| EncryptedValue | string | *No description.* | +| Id | string | *No description.* | +| KeyId | string | *No description.* | +| PlaintextValue | string | *No description.* | +| SecretName | string | *No description.* | +| SelectedRepositoryIds | double[] | *No description.* | +| Value | string | *No description.* | +| ValueEncrypted | string | *No description.* | +| Visibility | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `RemoteUpdatedAt`Required + +```csharp +public string RemoteUpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `DestroyOnDriftInput`Optional + +```csharp +public bool|IResolvable DestroyOnDriftInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `EncryptedValueInput`Optional + +```csharp +public string EncryptedValueInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `KeyIdInput`Optional + +```csharp +public string KeyIdInput { get; } +``` + +- *Type:* string + +--- + +##### `PlaintextValueInput`Optional + +```csharp +public string PlaintextValueInput { get; } +``` + +- *Type:* string + +--- + +##### `SecretNameInput`Optional + +```csharp +public string SecretNameInput { get; } +``` + +- *Type:* string + +--- + +##### `SelectedRepositoryIdsInput`Optional + +```csharp +public double[] SelectedRepositoryIdsInput { get; } +``` + +- *Type:* double[] + +--- + +##### `ValueEncryptedInput`Optional + +```csharp +public string ValueEncryptedInput { get; } +``` + +- *Type:* string + +--- + +##### `ValueInput`Optional + +```csharp +public string ValueInput { get; } +``` + +- *Type:* string + +--- + +##### `VisibilityInput`Optional + +```csharp +public string VisibilityInput { get; } +``` + +- *Type:* string + +--- + +##### `DestroyOnDrift`Required + +```csharp +public bool|IResolvable DestroyOnDrift { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `EncryptedValue`Required + +```csharp +public string EncryptedValue { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `KeyId`Required + +```csharp +public string KeyId { get; } +``` + +- *Type:* string + +--- + +##### `PlaintextValue`Required + +```csharp +public string PlaintextValue { get; } +``` + +- *Type:* string + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; } +``` + +- *Type:* string + +--- + +##### `SelectedRepositoryIds`Required + +```csharp +public double[] SelectedRepositoryIds { get; } +``` + +- *Type:* double[] + +--- + +##### `Value`Required + +```csharp +public string Value { get; } +``` + +- *Type:* string + +--- + +##### `ValueEncrypted`Required + +```csharp +public string ValueEncrypted { get; } +``` + +- *Type:* string + +--- + +##### `Visibility`Required + +```csharp +public string Visibility { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### ActionsOrganizationSecretConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsOrganizationSecretConfig { + 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 SecretName, + string Visibility, + bool|IResolvable DestroyOnDrift = null, + string EncryptedValue = null, + string Id = null, + string KeyId = null, + string PlaintextValue = null, + double[] SelectedRepositoryIds = null, + string Value = null, + string ValueEncrypted = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| SecretName | string | Name of the secret. | +| Visibility | string | Configures the access that repositories have to the organization secret. Must be one of 'all', 'private', or 'selected'. | +| DestroyOnDrift | bool\|Io.Cdktn.IResolvable | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#destroy_on_drift ActionsOrganizationSecret#destroy_on_drift}. | +| EncryptedValue | string | Encrypted value of the secret using the GitHub public key in Base64 format. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#id ActionsOrganizationSecret#id}. | +| KeyId | string | ID of the public key used to encrypt the secret. | +| PlaintextValue | string | Plaintext value of the secret to be encrypted. | +| SelectedRepositoryIds | double[] | An array of repository IDs that can access the organization secret. | +| Value | string | Plaintext value to be encrypted. | +| ValueEncrypted | string | Value encrypted with the GitHub public key, defined by key_id, in Base64 format. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; set; } +``` + +- *Type:* string + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#secret_name ActionsOrganizationSecret#secret_name} + +--- + +##### `Visibility`Required + +```csharp +public string Visibility { get; set; } +``` + +- *Type:* string + +Configures the access that repositories have to the organization secret. Must be one of 'all', 'private', or 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#visibility ActionsOrganizationSecret#visibility} + +--- + +##### `DestroyOnDrift`Optional + +```csharp +public bool|IResolvable DestroyOnDrift { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#destroy_on_drift ActionsOrganizationSecret#destroy_on_drift}. + +--- + +##### `EncryptedValue`Optional + +```csharp +public string EncryptedValue { get; set; } +``` + +- *Type:* string + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#encrypted_value ActionsOrganizationSecret#encrypted_value} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#id ActionsOrganizationSecret#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. + +--- + +##### `KeyId`Optional + +```csharp +public string KeyId { get; set; } +``` + +- *Type:* string + +ID of the public key used to encrypt the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#key_id ActionsOrganizationSecret#key_id} + +--- + +##### `PlaintextValue`Optional + +```csharp +public string PlaintextValue { get; set; } +``` + +- *Type:* string + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#plaintext_value ActionsOrganizationSecret#plaintext_value} + +--- + +##### `SelectedRepositoryIds`Optional + +```csharp +public double[] SelectedRepositoryIds { get; set; } +``` + +- *Type:* double[] + +An array of repository IDs that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#selected_repository_ids ActionsOrganizationSecret#selected_repository_ids} + +--- + +##### `Value`Optional + +```csharp +public string Value { get; set; } +``` + +- *Type:* string + +Plaintext value to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#value ActionsOrganizationSecret#value} + +--- + +##### `ValueEncrypted`Optional + +```csharp +public string ValueEncrypted { get; set; } +``` + +- *Type:* string + +Value encrypted with the GitHub public key, defined by key_id, in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#value_encrypted ActionsOrganizationSecret#value_encrypted} + +--- + + + diff --git a/docs/actionsOrganizationSecret.java.md b/docs/actionsOrganizationSecret.java.md new file mode 100644 index 000000000..8595fee74 --- /dev/null +++ b/docs/actionsOrganizationSecret.java.md @@ -0,0 +1,1429 @@ +# `actionsOrganizationSecret` Submodule + +## Constructs + +### ActionsOrganizationSecret + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret github_actions_organization_secret}. + +#### Initializers + +```java +import io.cdktn.providers.github.actions_organization_secret.ActionsOrganizationSecret; + +ActionsOrganizationSecret.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .secretName(java.lang.String) + .visibility(java.lang.String) +// .destroyOnDrift(java.lang.Boolean|IResolvable) +// .encryptedValue(java.lang.String) +// .id(java.lang.String) +// .keyId(java.lang.String) +// .plaintextValue(java.lang.String) +// .selectedRepositoryIds(java.util.List) +// .value(java.lang.String) +// .valueEncrypted(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 | *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 | *No description.* | +| secretName | java.lang.String | Name of the secret. | +| visibility | java.lang.String | Configures the access that repositories have to the organization secret. Must be one of 'all', 'private', or 'selected'. | +| destroyOnDrift | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#destroy_on_drift ActionsOrganizationSecret#destroy_on_drift}. | +| encryptedValue | java.lang.String | Encrypted value of the secret using the GitHub public key in Base64 format. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#id ActionsOrganizationSecret#id}. | +| keyId | java.lang.String | ID of the public key used to encrypt the secret. | +| plaintextValue | java.lang.String | Plaintext value of the secret to be encrypted. | +| selectedRepositoryIds | java.util.List | An array of repository IDs that can access the organization secret. | +| value | java.lang.String | Plaintext value to be encrypted. | +| valueEncrypted | java.lang.String | Value encrypted with the GitHub public key, defined by key_id, in Base64 format. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `secretName`Required + +- *Type:* java.lang.String + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#secret_name ActionsOrganizationSecret#secret_name} + +--- + +##### `visibility`Required + +- *Type:* java.lang.String + +Configures the access that repositories have to the organization secret. Must be one of 'all', 'private', or 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#visibility ActionsOrganizationSecret#visibility} + +--- + +##### `destroyOnDrift`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/resources/actions_organization_secret#destroy_on_drift ActionsOrganizationSecret#destroy_on_drift}. + +--- + +##### `encryptedValue`Optional + +- *Type:* java.lang.String + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#encrypted_value ActionsOrganizationSecret#encrypted_value} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#id ActionsOrganizationSecret#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. + +--- + +##### `keyId`Optional + +- *Type:* java.lang.String + +ID of the public key used to encrypt the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#key_id ActionsOrganizationSecret#key_id} + +--- + +##### `plaintextValue`Optional + +- *Type:* java.lang.String + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#plaintext_value ActionsOrganizationSecret#plaintext_value} + +--- + +##### `selectedRepositoryIds`Optional + +- *Type:* java.util.List + +An array of repository IDs that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#selected_repository_ids ActionsOrganizationSecret#selected_repository_ids} + +--- + +##### `value`Optional + +- *Type:* java.lang.String + +Plaintext value to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#value ActionsOrganizationSecret#value} + +--- + +##### `valueEncrypted`Optional + +- *Type:* java.lang.String + +Value encrypted with the GitHub public key, defined by key_id, in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#value_encrypted ActionsOrganizationSecret#value_encrypted} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetDestroyOnDrift | *No description.* | +| resetEncryptedValue | *No description.* | +| resetId | *No description.* | +| resetKeyId | *No description.* | +| resetPlaintextValue | *No description.* | +| resetSelectedRepositoryIds | *No description.* | +| resetValue | *No description.* | +| resetValueEncrypted | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetDestroyOnDrift` + +```java +public void resetDestroyOnDrift() +``` + +##### `resetEncryptedValue` + +```java +public void resetEncryptedValue() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetKeyId` + +```java +public void resetKeyId() +``` + +##### `resetPlaintextValue` + +```java +public void resetPlaintextValue() +``` + +##### `resetSelectedRepositoryIds` + +```java +public void resetSelectedRepositoryIds() +``` + +##### `resetValue` + +```java +public void resetValue() +``` + +##### `resetValueEncrypted` + +```java +public void resetValueEncrypted() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a ActionsOrganizationSecret resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.actions_organization_secret.ActionsOrganizationSecret; + +ActionsOrganizationSecret.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` + +```java +import io.cdktn.providers.github.actions_organization_secret.ActionsOrganizationSecret; + +ActionsOrganizationSecret.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.actions_organization_secret.ActionsOrganizationSecret; + +ActionsOrganizationSecret.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.actions_organization_secret.ActionsOrganizationSecret; + +ActionsOrganizationSecret.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ActionsOrganizationSecret.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a ActionsOrganizationSecret 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 ActionsOrganizationSecret to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing ActionsOrganizationSecret that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#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 ActionsOrganizationSecret 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| createdAt | java.lang.String | *No description.* | +| remoteUpdatedAt | java.lang.String | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| destroyOnDriftInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| encryptedValueInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| keyIdInput | java.lang.String | *No description.* | +| plaintextValueInput | java.lang.String | *No description.* | +| secretNameInput | java.lang.String | *No description.* | +| selectedRepositoryIdsInput | java.util.List | *No description.* | +| valueEncryptedInput | java.lang.String | *No description.* | +| valueInput | java.lang.String | *No description.* | +| visibilityInput | java.lang.String | *No description.* | +| destroyOnDrift | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| encryptedValue | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| keyId | java.lang.String | *No description.* | +| plaintextValue | java.lang.String | *No description.* | +| secretName | java.lang.String | *No description.* | +| selectedRepositoryIds | java.util.List | *No description.* | +| value | java.lang.String | *No description.* | +| valueEncrypted | java.lang.String | *No description.* | +| visibility | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `remoteUpdatedAt`Required + +```java +public java.lang.String getRemoteUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `destroyOnDriftInput`Optional + +```java +public java.lang.Boolean|IResolvable getDestroyOnDriftInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `encryptedValueInput`Optional + +```java +public java.lang.String getEncryptedValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `keyIdInput`Optional + +```java +public java.lang.String getKeyIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `plaintextValueInput`Optional + +```java +public java.lang.String getPlaintextValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretNameInput`Optional + +```java +public java.lang.String getSecretNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `selectedRepositoryIdsInput`Optional + +```java +public java.util.List getSelectedRepositoryIdsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `valueEncryptedInput`Optional + +```java +public java.lang.String getValueEncryptedInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `valueInput`Optional + +```java +public java.lang.String getValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `visibilityInput`Optional + +```java +public java.lang.String getVisibilityInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `destroyOnDrift`Required + +```java +public java.lang.Boolean|IResolvable getDestroyOnDrift(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `encryptedValue`Required + +```java +public java.lang.String getEncryptedValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `keyId`Required + +```java +public java.lang.String getKeyId(); +``` + +- *Type:* java.lang.String + +--- + +##### `plaintextValue`Required + +```java +public java.lang.String getPlaintextValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +--- + +##### `selectedRepositoryIds`Required + +```java +public java.util.List getSelectedRepositoryIds(); +``` + +- *Type:* java.util.List + +--- + +##### `value`Required + +```java +public java.lang.String getValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `valueEncrypted`Required + +```java +public java.lang.String getValueEncrypted(); +``` + +- *Type:* java.lang.String + +--- + +##### `visibility`Required + +```java +public java.lang.String getVisibility(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### ActionsOrganizationSecretConfig + +#### Initializer + +```java +import io.cdktn.providers.github.actions_organization_secret.ActionsOrganizationSecretConfig; + +ActionsOrganizationSecretConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .secretName(java.lang.String) + .visibility(java.lang.String) +// .destroyOnDrift(java.lang.Boolean|IResolvable) +// .encryptedValue(java.lang.String) +// .id(java.lang.String) +// .keyId(java.lang.String) +// .plaintextValue(java.lang.String) +// .selectedRepositoryIds(java.util.List) +// .value(java.lang.String) +// .valueEncrypted(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 | *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 | *No description.* | +| secretName | java.lang.String | Name of the secret. | +| visibility | java.lang.String | Configures the access that repositories have to the organization secret. Must be one of 'all', 'private', or 'selected'. | +| destroyOnDrift | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#destroy_on_drift ActionsOrganizationSecret#destroy_on_drift}. | +| encryptedValue | java.lang.String | Encrypted value of the secret using the GitHub public key in Base64 format. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#id ActionsOrganizationSecret#id}. | +| keyId | java.lang.String | ID of the public key used to encrypt the secret. | +| plaintextValue | java.lang.String | Plaintext value of the secret to be encrypted. | +| selectedRepositoryIds | java.util.List | An array of repository IDs that can access the organization secret. | +| value | java.lang.String | Plaintext value to be encrypted. | +| valueEncrypted | java.lang.String | Value encrypted with the GitHub public key, defined by key_id, in Base64 format. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#secret_name ActionsOrganizationSecret#secret_name} + +--- + +##### `visibility`Required + +```java +public java.lang.String getVisibility(); +``` + +- *Type:* java.lang.String + +Configures the access that repositories have to the organization secret. Must be one of 'all', 'private', or 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#visibility ActionsOrganizationSecret#visibility} + +--- + +##### `destroyOnDrift`Optional + +```java +public java.lang.Boolean|IResolvable getDestroyOnDrift(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#destroy_on_drift ActionsOrganizationSecret#destroy_on_drift}. + +--- + +##### `encryptedValue`Optional + +```java +public java.lang.String getEncryptedValue(); +``` + +- *Type:* java.lang.String + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#encrypted_value ActionsOrganizationSecret#encrypted_value} + +--- + +##### `id`Optional + +```java +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/resources/actions_organization_secret#id ActionsOrganizationSecret#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. + +--- + +##### `keyId`Optional + +```java +public java.lang.String getKeyId(); +``` + +- *Type:* java.lang.String + +ID of the public key used to encrypt the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#key_id ActionsOrganizationSecret#key_id} + +--- + +##### `plaintextValue`Optional + +```java +public java.lang.String getPlaintextValue(); +``` + +- *Type:* java.lang.String + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#plaintext_value ActionsOrganizationSecret#plaintext_value} + +--- + +##### `selectedRepositoryIds`Optional + +```java +public java.util.List getSelectedRepositoryIds(); +``` + +- *Type:* java.util.List + +An array of repository IDs that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#selected_repository_ids ActionsOrganizationSecret#selected_repository_ids} + +--- + +##### `value`Optional + +```java +public java.lang.String getValue(); +``` + +- *Type:* java.lang.String + +Plaintext value to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#value ActionsOrganizationSecret#value} + +--- + +##### `valueEncrypted`Optional + +```java +public java.lang.String getValueEncrypted(); +``` + +- *Type:* java.lang.String + +Value encrypted with the GitHub public key, defined by key_id, in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret#value_encrypted ActionsOrganizationSecret#value_encrypted} + +--- + + + diff --git a/docs/actionsOrganizationSecretRepositories.csharp.md b/docs/actionsOrganizationSecretRepositories.csharp.md new file mode 100644 index 000000000..fc1cbe0e5 --- /dev/null +++ b/docs/actionsOrganizationSecretRepositories.csharp.md @@ -0,0 +1,912 @@ +# `actionsOrganizationSecretRepositories` Submodule + +## Constructs + +### ActionsOrganizationSecretRepositories + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repositories github_actions_organization_secret_repositories}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsOrganizationSecretRepositories(Construct Scope, string Id, ActionsOrganizationSecretRepositoriesConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | ActionsOrganizationSecretRepositoriesConfig | *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:* ActionsOrganizationSecretRepositoriesConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a ActionsOrganizationSecretRepositories resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationSecretRepositories.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` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationSecretRepositories.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationSecretRepositories.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationSecretRepositories.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a ActionsOrganizationSecretRepositories resource upon running "cdktn 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 ActionsOrganizationSecretRepositories to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing ActionsOrganizationSecretRepositories that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repositories#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the ActionsOrganizationSecretRepositories to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| IdInput | string | *No description.* | +| SecretNameInput | string | *No description.* | +| SelectedRepositoryIdsInput | double[] | *No description.* | +| Id | string | *No description.* | +| SecretName | string | *No description.* | +| SelectedRepositoryIds | double[] | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `SecretNameInput`Optional + +```csharp +public string SecretNameInput { get; } +``` + +- *Type:* string + +--- + +##### `SelectedRepositoryIdsInput`Optional + +```csharp +public double[] SelectedRepositoryIdsInput { get; } +``` + +- *Type:* double[] + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; } +``` + +- *Type:* string + +--- + +##### `SelectedRepositoryIds`Required + +```csharp +public double[] SelectedRepositoryIds { get; } +``` + +- *Type:* double[] + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### ActionsOrganizationSecretRepositoriesConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsOrganizationSecretRepositoriesConfig { + 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 SecretName, + double[] SelectedRepositoryIds, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| SecretName | string | Name of the existing secret. | +| SelectedRepositoryIds | double[] | An array of repository ids that can access the organization secret. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repositories#id ActionsOrganizationSecretRepositories#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; set; } +``` + +- *Type:* string + +Name of the existing secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repositories#secret_name ActionsOrganizationSecretRepositories#secret_name} + +--- + +##### `SelectedRepositoryIds`Required + +```csharp +public double[] SelectedRepositoryIds { get; set; } +``` + +- *Type:* double[] + +An array of repository ids that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repositories#selected_repository_ids ActionsOrganizationSecretRepositories#selected_repository_ids} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repositories#id ActionsOrganizationSecretRepositories#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. + +--- + + + diff --git a/docs/actionsOrganizationSecretRepositories.java.md b/docs/actionsOrganizationSecretRepositories.java.md new file mode 100644 index 000000000..422480895 --- /dev/null +++ b/docs/actionsOrganizationSecretRepositories.java.md @@ -0,0 +1,1001 @@ +# `actionsOrganizationSecretRepositories` Submodule + +## Constructs + +### ActionsOrganizationSecretRepositories + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repositories github_actions_organization_secret_repositories}. + +#### Initializers + +```java +import io.cdktn.providers.github.actions_organization_secret_repositories.ActionsOrganizationSecretRepositories; + +ActionsOrganizationSecretRepositories.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .secretName(java.lang.String) + .selectedRepositoryIds(java.util.List) +// .id(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 | *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 | *No description.* | +| secretName | java.lang.String | Name of the existing secret. | +| selectedRepositoryIds | java.util.List | An array of repository ids that can access the organization secret. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repositories#id ActionsOrganizationSecretRepositories#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `secretName`Required + +- *Type:* java.lang.String + +Name of the existing secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repositories#secret_name ActionsOrganizationSecretRepositories#secret_name} + +--- + +##### `selectedRepositoryIds`Required + +- *Type:* java.util.List + +An array of repository ids that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repositories#selected_repository_ids ActionsOrganizationSecretRepositories#selected_repository_ids} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repositories#id ActionsOrganizationSecretRepositories#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a ActionsOrganizationSecretRepositories resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.actions_organization_secret_repositories.ActionsOrganizationSecretRepositories; + +ActionsOrganizationSecretRepositories.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` + +```java +import io.cdktn.providers.github.actions_organization_secret_repositories.ActionsOrganizationSecretRepositories; + +ActionsOrganizationSecretRepositories.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.actions_organization_secret_repositories.ActionsOrganizationSecretRepositories; + +ActionsOrganizationSecretRepositories.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.actions_organization_secret_repositories.ActionsOrganizationSecretRepositories; + +ActionsOrganizationSecretRepositories.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ActionsOrganizationSecretRepositories.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a ActionsOrganizationSecretRepositories 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 ActionsOrganizationSecretRepositories to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing ActionsOrganizationSecretRepositories that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_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 ActionsOrganizationSecretRepositories 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| idInput | java.lang.String | *No description.* | +| secretNameInput | java.lang.String | *No description.* | +| selectedRepositoryIdsInput | java.util.List | *No description.* | +| id | java.lang.String | *No description.* | +| secretName | java.lang.String | *No description.* | +| selectedRepositoryIds | java.util.List | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretNameInput`Optional + +```java +public java.lang.String getSecretNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `selectedRepositoryIdsInput`Optional + +```java +public java.util.List getSelectedRepositoryIdsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +--- + +##### `selectedRepositoryIds`Required + +```java +public java.util.List getSelectedRepositoryIds(); +``` + +- *Type:* java.util.List + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### ActionsOrganizationSecretRepositoriesConfig + +#### Initializer + +```java +import io.cdktn.providers.github.actions_organization_secret_repositories.ActionsOrganizationSecretRepositoriesConfig; + +ActionsOrganizationSecretRepositoriesConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .secretName(java.lang.String) + .selectedRepositoryIds(java.util.List) +// .id(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 | *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 | *No description.* | +| secretName | java.lang.String | Name of the existing secret. | +| selectedRepositoryIds | java.util.List | An array of repository ids that can access the organization secret. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repositories#id ActionsOrganizationSecretRepositories#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +Name of the existing secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repositories#secret_name ActionsOrganizationSecretRepositories#secret_name} + +--- + +##### `selectedRepositoryIds`Required + +```java +public java.util.List getSelectedRepositoryIds(); +``` + +- *Type:* java.util.List + +An array of repository ids that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repositories#selected_repository_ids ActionsOrganizationSecretRepositories#selected_repository_ids} + +--- + +##### `id`Optional + +```java +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/resources/actions_organization_secret_repositories#id ActionsOrganizationSecretRepositories#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. + +--- + + + diff --git a/docs/actionsOrganizationSecretRepository.csharp.md b/docs/actionsOrganizationSecretRepository.csharp.md new file mode 100644 index 000000000..2aaf2e101 --- /dev/null +++ b/docs/actionsOrganizationSecretRepository.csharp.md @@ -0,0 +1,912 @@ +# `actionsOrganizationSecretRepository` Submodule + +## Constructs + +### ActionsOrganizationSecretRepository + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repository github_actions_organization_secret_repository}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsOrganizationSecretRepository(Construct Scope, string Id, ActionsOrganizationSecretRepositoryConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | ActionsOrganizationSecretRepositoryConfig | *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:* ActionsOrganizationSecretRepositoryConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a ActionsOrganizationSecretRepository resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationSecretRepository.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` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationSecretRepository.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationSecretRepository.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationSecretRepository.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a ActionsOrganizationSecretRepository resource upon running "cdktn 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 ActionsOrganizationSecretRepository to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing ActionsOrganizationSecretRepository that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repository#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the ActionsOrganizationSecretRepository to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| IdInput | string | *No description.* | +| RepositoryIdInput | double | *No description.* | +| SecretNameInput | string | *No description.* | +| Id | string | *No description.* | +| RepositoryId | double | *No description.* | +| SecretName | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryIdInput`Optional + +```csharp +public double RepositoryIdInput { get; } +``` + +- *Type:* double + +--- + +##### `SecretNameInput`Optional + +```csharp +public string SecretNameInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryId`Required + +```csharp +public double RepositoryId { get; } +``` + +- *Type:* double + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### ActionsOrganizationSecretRepositoryConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsOrganizationSecretRepositoryConfig { + 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, + double RepositoryId, + string SecretName, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| RepositoryId | double | The repository ID that can access the organization secret. | +| SecretName | string | Name of the existing secret. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repository#id ActionsOrganizationSecretRepository#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `RepositoryId`Required + +```csharp +public double RepositoryId { get; set; } +``` + +- *Type:* double + +The repository ID that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repository#repository_id ActionsOrganizationSecretRepository#repository_id} + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; set; } +``` + +- *Type:* string + +Name of the existing secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repository#secret_name ActionsOrganizationSecretRepository#secret_name} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repository#id ActionsOrganizationSecretRepository#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. + +--- + + + diff --git a/docs/actionsOrganizationSecretRepository.java.md b/docs/actionsOrganizationSecretRepository.java.md new file mode 100644 index 000000000..786a3839d --- /dev/null +++ b/docs/actionsOrganizationSecretRepository.java.md @@ -0,0 +1,1001 @@ +# `actionsOrganizationSecretRepository` Submodule + +## Constructs + +### ActionsOrganizationSecretRepository + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repository github_actions_organization_secret_repository}. + +#### Initializers + +```java +import io.cdktn.providers.github.actions_organization_secret_repository.ActionsOrganizationSecretRepository; + +ActionsOrganizationSecretRepository.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repositoryId(java.lang.Number) + .secretName(java.lang.String) +// .id(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 | *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 | *No description.* | +| repositoryId | java.lang.Number | The repository ID that can access the organization secret. | +| secretName | java.lang.String | Name of the existing secret. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repository#id ActionsOrganizationSecretRepository#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repositoryId`Required + +- *Type:* java.lang.Number + +The repository ID that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repository#repository_id ActionsOrganizationSecretRepository#repository_id} + +--- + +##### `secretName`Required + +- *Type:* java.lang.String + +Name of the existing secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repository#secret_name ActionsOrganizationSecretRepository#secret_name} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repository#id ActionsOrganizationSecretRepository#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a ActionsOrganizationSecretRepository resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.actions_organization_secret_repository.ActionsOrganizationSecretRepository; + +ActionsOrganizationSecretRepository.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` + +```java +import io.cdktn.providers.github.actions_organization_secret_repository.ActionsOrganizationSecretRepository; + +ActionsOrganizationSecretRepository.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.actions_organization_secret_repository.ActionsOrganizationSecretRepository; + +ActionsOrganizationSecretRepository.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.actions_organization_secret_repository.ActionsOrganizationSecretRepository; + +ActionsOrganizationSecretRepository.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ActionsOrganizationSecretRepository.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a ActionsOrganizationSecretRepository 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 ActionsOrganizationSecretRepository to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing ActionsOrganizationSecretRepository that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repository#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 ActionsOrganizationSecretRepository 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryIdInput | java.lang.Number | *No description.* | +| secretNameInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repositoryId | java.lang.Number | *No description.* | +| secretName | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryIdInput`Optional + +```java +public java.lang.Number getRepositoryIdInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `secretNameInput`Optional + +```java +public java.lang.String getSecretNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryId`Required + +```java +public java.lang.Number getRepositoryId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### ActionsOrganizationSecretRepositoryConfig + +#### Initializer + +```java +import io.cdktn.providers.github.actions_organization_secret_repository.ActionsOrganizationSecretRepositoryConfig; + +ActionsOrganizationSecretRepositoryConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repositoryId(java.lang.Number) + .secretName(java.lang.String) +// .id(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 | *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 | *No description.* | +| repositoryId | java.lang.Number | The repository ID that can access the organization secret. | +| secretName | java.lang.String | Name of the existing secret. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repository#id ActionsOrganizationSecretRepository#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repositoryId`Required + +```java +public java.lang.Number getRepositoryId(); +``` + +- *Type:* java.lang.Number + +The repository ID that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repository#repository_id ActionsOrganizationSecretRepository#repository_id} + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +Name of the existing secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_secret_repository#secret_name ActionsOrganizationSecretRepository#secret_name} + +--- + +##### `id`Optional + +```java +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/resources/actions_organization_secret_repository#id ActionsOrganizationSecretRepository#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. + +--- + + + diff --git a/docs/actionsOrganizationVariable.csharp.md b/docs/actionsOrganizationVariable.csharp.md new file mode 100644 index 000000000..deb97a5fb --- /dev/null +++ b/docs/actionsOrganizationVariable.csharp.md @@ -0,0 +1,1019 @@ +# `actionsOrganizationVariable` Submodule + +## Constructs + +### ActionsOrganizationVariable + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable github_actions_organization_variable}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsOrganizationVariable(Construct Scope, string Id, ActionsOrganizationVariableConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | ActionsOrganizationVariableConfig | *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:* ActionsOrganizationVariableConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | +| ResetSelectedRepositoryIds | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetSelectedRepositoryIds` + +```csharp +private void ResetSelectedRepositoryIds() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a ActionsOrganizationVariable resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationVariable.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` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationVariable.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationVariable.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationVariable.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a ActionsOrganizationVariable resource upon running "cdktn 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 ActionsOrganizationVariable to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing ActionsOrganizationVariable that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the ActionsOrganizationVariable to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| CreatedAt | string | *No description.* | +| UpdatedAt | string | *No description.* | +| IdInput | string | *No description.* | +| SelectedRepositoryIdsInput | double[] | *No description.* | +| ValueInput | string | *No description.* | +| VariableNameInput | string | *No description.* | +| VisibilityInput | string | *No description.* | +| Id | string | *No description.* | +| SelectedRepositoryIds | double[] | *No description.* | +| Value | string | *No description.* | +| VariableName | string | *No description.* | +| Visibility | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `SelectedRepositoryIdsInput`Optional + +```csharp +public double[] SelectedRepositoryIdsInput { get; } +``` + +- *Type:* double[] + +--- + +##### `ValueInput`Optional + +```csharp +public string ValueInput { get; } +``` + +- *Type:* string + +--- + +##### `VariableNameInput`Optional + +```csharp +public string VariableNameInput { get; } +``` + +- *Type:* string + +--- + +##### `VisibilityInput`Optional + +```csharp +public string VisibilityInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `SelectedRepositoryIds`Required + +```csharp +public double[] SelectedRepositoryIds { get; } +``` + +- *Type:* double[] + +--- + +##### `Value`Required + +```csharp +public string Value { get; } +``` + +- *Type:* string + +--- + +##### `VariableName`Required + +```csharp +public string VariableName { get; } +``` + +- *Type:* string + +--- + +##### `Visibility`Required + +```csharp +public string Visibility { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### ActionsOrganizationVariableConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsOrganizationVariableConfig { + 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 Value, + string VariableName, + string Visibility, + string Id = null, + double[] SelectedRepositoryIds = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Value | string | Value of the variable. | +| VariableName | string | Name of the variable. | +| Visibility | string | Configures the access that repositories have to the organization variable. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable#id ActionsOrganizationVariable#id}. | +| SelectedRepositoryIds | double[] | An array of repository ids that can access the organization variable. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Value`Required + +```csharp +public string Value { get; set; } +``` + +- *Type:* string + +Value of the variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable#value ActionsOrganizationVariable#value} + +--- + +##### `VariableName`Required + +```csharp +public string VariableName { get; set; } +``` + +- *Type:* string + +Name of the variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable#variable_name ActionsOrganizationVariable#variable_name} + +--- + +##### `Visibility`Required + +```csharp +public string Visibility { get; set; } +``` + +- *Type:* string + +Configures the access that repositories have to the organization variable. + +Must be one of 'all', 'private', or 'selected'. 'selected_repository_ids' is required if set to 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable#visibility ActionsOrganizationVariable#visibility} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable#id ActionsOrganizationVariable#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. + +--- + +##### `SelectedRepositoryIds`Optional + +```csharp +public double[] SelectedRepositoryIds { get; set; } +``` + +- *Type:* double[] + +An array of repository ids that can access the organization variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable#selected_repository_ids ActionsOrganizationVariable#selected_repository_ids} + +--- + + + diff --git a/docs/actionsOrganizationVariable.java.md b/docs/actionsOrganizationVariable.java.md new file mode 100644 index 000000000..b50a9dbb8 --- /dev/null +++ b/docs/actionsOrganizationVariable.java.md @@ -0,0 +1,1134 @@ +# `actionsOrganizationVariable` Submodule + +## Constructs + +### ActionsOrganizationVariable + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable github_actions_organization_variable}. + +#### Initializers + +```java +import io.cdktn.providers.github.actions_organization_variable.ActionsOrganizationVariable; + +ActionsOrganizationVariable.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .value(java.lang.String) + .variableName(java.lang.String) + .visibility(java.lang.String) +// .id(java.lang.String) +// .selectedRepositoryIds(java.util.List) + .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 | *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 | *No description.* | +| value | java.lang.String | Value of the variable. | +| variableName | java.lang.String | Name of the variable. | +| visibility | java.lang.String | Configures the access that repositories have to the organization variable. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable#id ActionsOrganizationVariable#id}. | +| selectedRepositoryIds | java.util.List | An array of repository ids that can access the organization variable. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `value`Required + +- *Type:* java.lang.String + +Value of the variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable#value ActionsOrganizationVariable#value} + +--- + +##### `variableName`Required + +- *Type:* java.lang.String + +Name of the variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable#variable_name ActionsOrganizationVariable#variable_name} + +--- + +##### `visibility`Required + +- *Type:* java.lang.String + +Configures the access that repositories have to the organization variable. + +Must be one of 'all', 'private', or 'selected'. 'selected_repository_ids' is required if set to 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable#visibility ActionsOrganizationVariable#visibility} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable#id ActionsOrganizationVariable#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. + +--- + +##### `selectedRepositoryIds`Optional + +- *Type:* java.util.List + +An array of repository ids that can access the organization variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable#selected_repository_ids ActionsOrganizationVariable#selected_repository_ids} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | +| resetSelectedRepositoryIds | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetSelectedRepositoryIds` + +```java +public void resetSelectedRepositoryIds() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a ActionsOrganizationVariable resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.actions_organization_variable.ActionsOrganizationVariable; + +ActionsOrganizationVariable.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` + +```java +import io.cdktn.providers.github.actions_organization_variable.ActionsOrganizationVariable; + +ActionsOrganizationVariable.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.actions_organization_variable.ActionsOrganizationVariable; + +ActionsOrganizationVariable.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.actions_organization_variable.ActionsOrganizationVariable; + +ActionsOrganizationVariable.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ActionsOrganizationVariable.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a ActionsOrganizationVariable 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 ActionsOrganizationVariable to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing ActionsOrganizationVariable that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable#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 ActionsOrganizationVariable 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| createdAt | java.lang.String | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| selectedRepositoryIdsInput | java.util.List | *No description.* | +| valueInput | java.lang.String | *No description.* | +| variableNameInput | java.lang.String | *No description.* | +| visibilityInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| selectedRepositoryIds | java.util.List | *No description.* | +| value | java.lang.String | *No description.* | +| variableName | java.lang.String | *No description.* | +| visibility | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `selectedRepositoryIdsInput`Optional + +```java +public java.util.List getSelectedRepositoryIdsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `valueInput`Optional + +```java +public java.lang.String getValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `variableNameInput`Optional + +```java +public java.lang.String getVariableNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `visibilityInput`Optional + +```java +public java.lang.String getVisibilityInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `selectedRepositoryIds`Required + +```java +public java.util.List getSelectedRepositoryIds(); +``` + +- *Type:* java.util.List + +--- + +##### `value`Required + +```java +public java.lang.String getValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `variableName`Required + +```java +public java.lang.String getVariableName(); +``` + +- *Type:* java.lang.String + +--- + +##### `visibility`Required + +```java +public java.lang.String getVisibility(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### ActionsOrganizationVariableConfig + +#### Initializer + +```java +import io.cdktn.providers.github.actions_organization_variable.ActionsOrganizationVariableConfig; + +ActionsOrganizationVariableConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .value(java.lang.String) + .variableName(java.lang.String) + .visibility(java.lang.String) +// .id(java.lang.String) +// .selectedRepositoryIds(java.util.List) + .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 | *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 | *No description.* | +| value | java.lang.String | Value of the variable. | +| variableName | java.lang.String | Name of the variable. | +| visibility | java.lang.String | Configures the access that repositories have to the organization variable. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable#id ActionsOrganizationVariable#id}. | +| selectedRepositoryIds | java.util.List | An array of repository ids that can access the organization variable. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `value`Required + +```java +public java.lang.String getValue(); +``` + +- *Type:* java.lang.String + +Value of the variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable#value ActionsOrganizationVariable#value} + +--- + +##### `variableName`Required + +```java +public java.lang.String getVariableName(); +``` + +- *Type:* java.lang.String + +Name of the variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable#variable_name ActionsOrganizationVariable#variable_name} + +--- + +##### `visibility`Required + +```java +public java.lang.String getVisibility(); +``` + +- *Type:* java.lang.String + +Configures the access that repositories have to the organization variable. + +Must be one of 'all', 'private', or 'selected'. 'selected_repository_ids' is required if set to 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable#visibility ActionsOrganizationVariable#visibility} + +--- + +##### `id`Optional + +```java +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/resources/actions_organization_variable#id ActionsOrganizationVariable#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. + +--- + +##### `selectedRepositoryIds`Optional + +```java +public java.util.List getSelectedRepositoryIds(); +``` + +- *Type:* java.util.List + +An array of repository ids that can access the organization variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable#selected_repository_ids ActionsOrganizationVariable#selected_repository_ids} + +--- + + + diff --git a/docs/actionsOrganizationVariableRepositories.csharp.md b/docs/actionsOrganizationVariableRepositories.csharp.md new file mode 100644 index 000000000..2f15532da --- /dev/null +++ b/docs/actionsOrganizationVariableRepositories.csharp.md @@ -0,0 +1,912 @@ +# `actionsOrganizationVariableRepositories` Submodule + +## Constructs + +### ActionsOrganizationVariableRepositories + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repositories github_actions_organization_variable_repositories}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsOrganizationVariableRepositories(Construct Scope, string Id, ActionsOrganizationVariableRepositoriesConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | ActionsOrganizationVariableRepositoriesConfig | *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:* ActionsOrganizationVariableRepositoriesConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a ActionsOrganizationVariableRepositories resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationVariableRepositories.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` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationVariableRepositories.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationVariableRepositories.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationVariableRepositories.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a ActionsOrganizationVariableRepositories resource upon running "cdktn 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 ActionsOrganizationVariableRepositories to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing ActionsOrganizationVariableRepositories that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repositories#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the ActionsOrganizationVariableRepositories to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| IdInput | string | *No description.* | +| SelectedRepositoryIdsInput | double[] | *No description.* | +| VariableNameInput | string | *No description.* | +| Id | string | *No description.* | +| SelectedRepositoryIds | double[] | *No description.* | +| VariableName | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `SelectedRepositoryIdsInput`Optional + +```csharp +public double[] SelectedRepositoryIdsInput { get; } +``` + +- *Type:* double[] + +--- + +##### `VariableNameInput`Optional + +```csharp +public string VariableNameInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `SelectedRepositoryIds`Required + +```csharp +public double[] SelectedRepositoryIds { get; } +``` + +- *Type:* double[] + +--- + +##### `VariableName`Required + +```csharp +public string VariableName { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### ActionsOrganizationVariableRepositoriesConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsOrganizationVariableRepositoriesConfig { + 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, + double[] SelectedRepositoryIds, + string VariableName, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| SelectedRepositoryIds | double[] | An array of repository ids that can access the organization variable. | +| VariableName | string | Name of the existing variable. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repositories#id ActionsOrganizationVariableRepositories#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `SelectedRepositoryIds`Required + +```csharp +public double[] SelectedRepositoryIds { get; set; } +``` + +- *Type:* double[] + +An array of repository ids that can access the organization variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repositories#selected_repository_ids ActionsOrganizationVariableRepositories#selected_repository_ids} + +--- + +##### `VariableName`Required + +```csharp +public string VariableName { get; set; } +``` + +- *Type:* string + +Name of the existing variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repositories#variable_name ActionsOrganizationVariableRepositories#variable_name} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repositories#id ActionsOrganizationVariableRepositories#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. + +--- + + + diff --git a/docs/actionsOrganizationVariableRepositories.java.md b/docs/actionsOrganizationVariableRepositories.java.md new file mode 100644 index 000000000..779c8448c --- /dev/null +++ b/docs/actionsOrganizationVariableRepositories.java.md @@ -0,0 +1,1001 @@ +# `actionsOrganizationVariableRepositories` Submodule + +## Constructs + +### ActionsOrganizationVariableRepositories + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repositories github_actions_organization_variable_repositories}. + +#### Initializers + +```java +import io.cdktn.providers.github.actions_organization_variable_repositories.ActionsOrganizationVariableRepositories; + +ActionsOrganizationVariableRepositories.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .selectedRepositoryIds(java.util.List) + .variableName(java.lang.String) +// .id(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 | *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 | *No description.* | +| selectedRepositoryIds | java.util.List | An array of repository ids that can access the organization variable. | +| variableName | java.lang.String | Name of the existing variable. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repositories#id ActionsOrganizationVariableRepositories#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `selectedRepositoryIds`Required + +- *Type:* java.util.List + +An array of repository ids that can access the organization variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repositories#selected_repository_ids ActionsOrganizationVariableRepositories#selected_repository_ids} + +--- + +##### `variableName`Required + +- *Type:* java.lang.String + +Name of the existing variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repositories#variable_name ActionsOrganizationVariableRepositories#variable_name} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repositories#id ActionsOrganizationVariableRepositories#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a ActionsOrganizationVariableRepositories resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.actions_organization_variable_repositories.ActionsOrganizationVariableRepositories; + +ActionsOrganizationVariableRepositories.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` + +```java +import io.cdktn.providers.github.actions_organization_variable_repositories.ActionsOrganizationVariableRepositories; + +ActionsOrganizationVariableRepositories.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.actions_organization_variable_repositories.ActionsOrganizationVariableRepositories; + +ActionsOrganizationVariableRepositories.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.actions_organization_variable_repositories.ActionsOrganizationVariableRepositories; + +ActionsOrganizationVariableRepositories.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ActionsOrganizationVariableRepositories.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a ActionsOrganizationVariableRepositories 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 ActionsOrganizationVariableRepositories to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing ActionsOrganizationVariableRepositories that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_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 ActionsOrganizationVariableRepositories 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| idInput | java.lang.String | *No description.* | +| selectedRepositoryIdsInput | java.util.List | *No description.* | +| variableNameInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| selectedRepositoryIds | java.util.List | *No description.* | +| variableName | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `selectedRepositoryIdsInput`Optional + +```java +public java.util.List getSelectedRepositoryIdsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `variableNameInput`Optional + +```java +public java.lang.String getVariableNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `selectedRepositoryIds`Required + +```java +public java.util.List getSelectedRepositoryIds(); +``` + +- *Type:* java.util.List + +--- + +##### `variableName`Required + +```java +public java.lang.String getVariableName(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### ActionsOrganizationVariableRepositoriesConfig + +#### Initializer + +```java +import io.cdktn.providers.github.actions_organization_variable_repositories.ActionsOrganizationVariableRepositoriesConfig; + +ActionsOrganizationVariableRepositoriesConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .selectedRepositoryIds(java.util.List) + .variableName(java.lang.String) +// .id(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 | *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 | *No description.* | +| selectedRepositoryIds | java.util.List | An array of repository ids that can access the organization variable. | +| variableName | java.lang.String | Name of the existing variable. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repositories#id ActionsOrganizationVariableRepositories#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `selectedRepositoryIds`Required + +```java +public java.util.List getSelectedRepositoryIds(); +``` + +- *Type:* java.util.List + +An array of repository ids that can access the organization variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repositories#selected_repository_ids ActionsOrganizationVariableRepositories#selected_repository_ids} + +--- + +##### `variableName`Required + +```java +public java.lang.String getVariableName(); +``` + +- *Type:* java.lang.String + +Name of the existing variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repositories#variable_name ActionsOrganizationVariableRepositories#variable_name} + +--- + +##### `id`Optional + +```java +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/resources/actions_organization_variable_repositories#id ActionsOrganizationVariableRepositories#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. + +--- + + + diff --git a/docs/actionsOrganizationVariableRepository.csharp.md b/docs/actionsOrganizationVariableRepository.csharp.md new file mode 100644 index 000000000..e6e0f9d09 --- /dev/null +++ b/docs/actionsOrganizationVariableRepository.csharp.md @@ -0,0 +1,912 @@ +# `actionsOrganizationVariableRepository` Submodule + +## Constructs + +### ActionsOrganizationVariableRepository + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repository github_actions_organization_variable_repository}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsOrganizationVariableRepository(Construct Scope, string Id, ActionsOrganizationVariableRepositoryConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | ActionsOrganizationVariableRepositoryConfig | *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:* ActionsOrganizationVariableRepositoryConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a ActionsOrganizationVariableRepository resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationVariableRepository.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` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationVariableRepository.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationVariableRepository.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationVariableRepository.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a ActionsOrganizationVariableRepository resource upon running "cdktn 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 ActionsOrganizationVariableRepository to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing ActionsOrganizationVariableRepository that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repository#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the ActionsOrganizationVariableRepository to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| IdInput | string | *No description.* | +| RepositoryIdInput | double | *No description.* | +| VariableNameInput | string | *No description.* | +| Id | string | *No description.* | +| RepositoryId | double | *No description.* | +| VariableName | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryIdInput`Optional + +```csharp +public double RepositoryIdInput { get; } +``` + +- *Type:* double + +--- + +##### `VariableNameInput`Optional + +```csharp +public string VariableNameInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryId`Required + +```csharp +public double RepositoryId { get; } +``` + +- *Type:* double + +--- + +##### `VariableName`Required + +```csharp +public string VariableName { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### ActionsOrganizationVariableRepositoryConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsOrganizationVariableRepositoryConfig { + 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, + double RepositoryId, + string VariableName, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| RepositoryId | double | The repository ID that can access the organization variable. | +| VariableName | string | Name of the existing variable. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repository#id ActionsOrganizationVariableRepository#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `RepositoryId`Required + +```csharp +public double RepositoryId { get; set; } +``` + +- *Type:* double + +The repository ID that can access the organization variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repository#repository_id ActionsOrganizationVariableRepository#repository_id} + +--- + +##### `VariableName`Required + +```csharp +public string VariableName { get; set; } +``` + +- *Type:* string + +Name of the existing variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repository#variable_name ActionsOrganizationVariableRepository#variable_name} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repository#id ActionsOrganizationVariableRepository#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. + +--- + + + diff --git a/docs/actionsOrganizationVariableRepository.java.md b/docs/actionsOrganizationVariableRepository.java.md new file mode 100644 index 000000000..be7f324d2 --- /dev/null +++ b/docs/actionsOrganizationVariableRepository.java.md @@ -0,0 +1,1001 @@ +# `actionsOrganizationVariableRepository` Submodule + +## Constructs + +### ActionsOrganizationVariableRepository + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repository github_actions_organization_variable_repository}. + +#### Initializers + +```java +import io.cdktn.providers.github.actions_organization_variable_repository.ActionsOrganizationVariableRepository; + +ActionsOrganizationVariableRepository.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repositoryId(java.lang.Number) + .variableName(java.lang.String) +// .id(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 | *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 | *No description.* | +| repositoryId | java.lang.Number | The repository ID that can access the organization variable. | +| variableName | java.lang.String | Name of the existing variable. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repository#id ActionsOrganizationVariableRepository#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repositoryId`Required + +- *Type:* java.lang.Number + +The repository ID that can access the organization variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repository#repository_id ActionsOrganizationVariableRepository#repository_id} + +--- + +##### `variableName`Required + +- *Type:* java.lang.String + +Name of the existing variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repository#variable_name ActionsOrganizationVariableRepository#variable_name} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repository#id ActionsOrganizationVariableRepository#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a ActionsOrganizationVariableRepository resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.actions_organization_variable_repository.ActionsOrganizationVariableRepository; + +ActionsOrganizationVariableRepository.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` + +```java +import io.cdktn.providers.github.actions_organization_variable_repository.ActionsOrganizationVariableRepository; + +ActionsOrganizationVariableRepository.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.actions_organization_variable_repository.ActionsOrganizationVariableRepository; + +ActionsOrganizationVariableRepository.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.actions_organization_variable_repository.ActionsOrganizationVariableRepository; + +ActionsOrganizationVariableRepository.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ActionsOrganizationVariableRepository.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a ActionsOrganizationVariableRepository 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 ActionsOrganizationVariableRepository to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing ActionsOrganizationVariableRepository that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repository#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 ActionsOrganizationVariableRepository 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryIdInput | java.lang.Number | *No description.* | +| variableNameInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repositoryId | java.lang.Number | *No description.* | +| variableName | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryIdInput`Optional + +```java +public java.lang.Number getRepositoryIdInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `variableNameInput`Optional + +```java +public java.lang.String getVariableNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryId`Required + +```java +public java.lang.Number getRepositoryId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `variableName`Required + +```java +public java.lang.String getVariableName(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### ActionsOrganizationVariableRepositoryConfig + +#### Initializer + +```java +import io.cdktn.providers.github.actions_organization_variable_repository.ActionsOrganizationVariableRepositoryConfig; + +ActionsOrganizationVariableRepositoryConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repositoryId(java.lang.Number) + .variableName(java.lang.String) +// .id(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 | *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 | *No description.* | +| repositoryId | java.lang.Number | The repository ID that can access the organization variable. | +| variableName | java.lang.String | Name of the existing variable. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repository#id ActionsOrganizationVariableRepository#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repositoryId`Required + +```java +public java.lang.Number getRepositoryId(); +``` + +- *Type:* java.lang.Number + +The repository ID that can access the organization variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repository#repository_id ActionsOrganizationVariableRepository#repository_id} + +--- + +##### `variableName`Required + +```java +public java.lang.String getVariableName(); +``` + +- *Type:* java.lang.String + +Name of the existing variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_variable_repository#variable_name ActionsOrganizationVariableRepository#variable_name} + +--- + +##### `id`Optional + +```java +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/resources/actions_organization_variable_repository#id ActionsOrganizationVariableRepository#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. + +--- + + + diff --git a/docs/actionsOrganizationWorkflowPermissions.csharp.md b/docs/actionsOrganizationWorkflowPermissions.csharp.md new file mode 100644 index 000000000..5ad0b88be --- /dev/null +++ b/docs/actionsOrganizationWorkflowPermissions.csharp.md @@ -0,0 +1,966 @@ +# `actionsOrganizationWorkflowPermissions` Submodule + +## Constructs + +### ActionsOrganizationWorkflowPermissions + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_workflow_permissions github_actions_organization_workflow_permissions}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsOrganizationWorkflowPermissions(Construct Scope, string Id, ActionsOrganizationWorkflowPermissionsConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | ActionsOrganizationWorkflowPermissionsConfig | *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:* ActionsOrganizationWorkflowPermissionsConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetCanApprovePullRequestReviews | *No description.* | +| ResetDefaultWorkflowPermissions | *No description.* | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetCanApprovePullRequestReviews` + +```csharp +private void ResetCanApprovePullRequestReviews() +``` + +##### `ResetDefaultWorkflowPermissions` + +```csharp +private void ResetDefaultWorkflowPermissions() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a ActionsOrganizationWorkflowPermissions resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationWorkflowPermissions.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` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationWorkflowPermissions.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationWorkflowPermissions.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsOrganizationWorkflowPermissions.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a ActionsOrganizationWorkflowPermissions resource upon running "cdktn 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 ActionsOrganizationWorkflowPermissions to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing ActionsOrganizationWorkflowPermissions that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_workflow_permissions#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the ActionsOrganizationWorkflowPermissions to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| CanApprovePullRequestReviewsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| DefaultWorkflowPermissionsInput | string | *No description.* | +| IdInput | string | *No description.* | +| OrganizationSlugInput | string | *No description.* | +| CanApprovePullRequestReviews | bool\|Io.Cdktn.IResolvable | *No description.* | +| DefaultWorkflowPermissions | string | *No description.* | +| Id | string | *No description.* | +| OrganizationSlug | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `CanApprovePullRequestReviewsInput`Optional + +```csharp +public bool|IResolvable CanApprovePullRequestReviewsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `DefaultWorkflowPermissionsInput`Optional + +```csharp +public string DefaultWorkflowPermissionsInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `OrganizationSlugInput`Optional + +```csharp +public string OrganizationSlugInput { get; } +``` + +- *Type:* string + +--- + +##### `CanApprovePullRequestReviews`Required + +```csharp +public bool|IResolvable CanApprovePullRequestReviews { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `DefaultWorkflowPermissions`Required + +```csharp +public string DefaultWorkflowPermissions { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `OrganizationSlug`Required + +```csharp +public string OrganizationSlug { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### ActionsOrganizationWorkflowPermissionsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsOrganizationWorkflowPermissionsConfig { + 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 OrganizationSlug, + bool|IResolvable CanApprovePullRequestReviews = null, + string DefaultWorkflowPermissions = null, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| OrganizationSlug | string | The slug of the Organization. | +| CanApprovePullRequestReviews | bool\|Io.Cdktn.IResolvable | Whether GitHub Actions can approve pull request reviews in any repository in the organization. | +| DefaultWorkflowPermissions | string | The default workflow permissions granted to the GITHUB_TOKEN when running workflows in any repository in the organization. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_workflow_permissions#id ActionsOrganizationWorkflowPermissions#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `OrganizationSlug`Required + +```csharp +public string OrganizationSlug { get; set; } +``` + +- *Type:* string + +The slug of the Organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_workflow_permissions#organization_slug ActionsOrganizationWorkflowPermissions#organization_slug} + +--- + +##### `CanApprovePullRequestReviews`Optional + +```csharp +public bool|IResolvable CanApprovePullRequestReviews { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether GitHub Actions can approve pull request reviews in any repository in the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_workflow_permissions#can_approve_pull_request_reviews ActionsOrganizationWorkflowPermissions#can_approve_pull_request_reviews} + +--- + +##### `DefaultWorkflowPermissions`Optional + +```csharp +public string DefaultWorkflowPermissions { get; set; } +``` + +- *Type:* string + +The default workflow permissions granted to the GITHUB_TOKEN when running workflows in any repository in the organization. + +Can be 'read' or 'write'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_workflow_permissions#default_workflow_permissions ActionsOrganizationWorkflowPermissions#default_workflow_permissions} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_workflow_permissions#id ActionsOrganizationWorkflowPermissions#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. + +--- + + + diff --git a/docs/actionsOrganizationWorkflowPermissions.java.md b/docs/actionsOrganizationWorkflowPermissions.java.md new file mode 100644 index 000000000..99d0dddb6 --- /dev/null +++ b/docs/actionsOrganizationWorkflowPermissions.java.md @@ -0,0 +1,1069 @@ +# `actionsOrganizationWorkflowPermissions` Submodule + +## Constructs + +### ActionsOrganizationWorkflowPermissions + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_workflow_permissions github_actions_organization_workflow_permissions}. + +#### Initializers + +```java +import io.cdktn.providers.github.actions_organization_workflow_permissions.ActionsOrganizationWorkflowPermissions; + +ActionsOrganizationWorkflowPermissions.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .organizationSlug(java.lang.String) +// .canApprovePullRequestReviews(java.lang.Boolean|IResolvable) +// .defaultWorkflowPermissions(java.lang.String) +// .id(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 | *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 | *No description.* | +| organizationSlug | java.lang.String | The slug of the Organization. | +| canApprovePullRequestReviews | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether GitHub Actions can approve pull request reviews in any repository in the organization. | +| defaultWorkflowPermissions | java.lang.String | The default workflow permissions granted to the GITHUB_TOKEN when running workflows in any repository in the organization. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_workflow_permissions#id ActionsOrganizationWorkflowPermissions#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `organizationSlug`Required + +- *Type:* java.lang.String + +The slug of the Organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_workflow_permissions#organization_slug ActionsOrganizationWorkflowPermissions#organization_slug} + +--- + +##### `canApprovePullRequestReviews`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether GitHub Actions can approve pull request reviews in any repository in the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_workflow_permissions#can_approve_pull_request_reviews ActionsOrganizationWorkflowPermissions#can_approve_pull_request_reviews} + +--- + +##### `defaultWorkflowPermissions`Optional + +- *Type:* java.lang.String + +The default workflow permissions granted to the GITHUB_TOKEN when running workflows in any repository in the organization. + +Can be 'read' or 'write'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_workflow_permissions#default_workflow_permissions ActionsOrganizationWorkflowPermissions#default_workflow_permissions} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_workflow_permissions#id ActionsOrganizationWorkflowPermissions#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetCanApprovePullRequestReviews | *No description.* | +| resetDefaultWorkflowPermissions | *No description.* | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetCanApprovePullRequestReviews` + +```java +public void resetCanApprovePullRequestReviews() +``` + +##### `resetDefaultWorkflowPermissions` + +```java +public void resetDefaultWorkflowPermissions() +``` + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a ActionsOrganizationWorkflowPermissions resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.actions_organization_workflow_permissions.ActionsOrganizationWorkflowPermissions; + +ActionsOrganizationWorkflowPermissions.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` + +```java +import io.cdktn.providers.github.actions_organization_workflow_permissions.ActionsOrganizationWorkflowPermissions; + +ActionsOrganizationWorkflowPermissions.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.actions_organization_workflow_permissions.ActionsOrganizationWorkflowPermissions; + +ActionsOrganizationWorkflowPermissions.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.actions_organization_workflow_permissions.ActionsOrganizationWorkflowPermissions; + +ActionsOrganizationWorkflowPermissions.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ActionsOrganizationWorkflowPermissions.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a ActionsOrganizationWorkflowPermissions 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 ActionsOrganizationWorkflowPermissions to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing ActionsOrganizationWorkflowPermissions that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_workflow_permissions#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 ActionsOrganizationWorkflowPermissions 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| canApprovePullRequestReviewsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| defaultWorkflowPermissionsInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| organizationSlugInput | java.lang.String | *No description.* | +| canApprovePullRequestReviews | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| defaultWorkflowPermissions | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| organizationSlug | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `canApprovePullRequestReviewsInput`Optional + +```java +public java.lang.Boolean|IResolvable getCanApprovePullRequestReviewsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `defaultWorkflowPermissionsInput`Optional + +```java +public java.lang.String getDefaultWorkflowPermissionsInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `organizationSlugInput`Optional + +```java +public java.lang.String getOrganizationSlugInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `canApprovePullRequestReviews`Required + +```java +public java.lang.Boolean|IResolvable getCanApprovePullRequestReviews(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `defaultWorkflowPermissions`Required + +```java +public java.lang.String getDefaultWorkflowPermissions(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `organizationSlug`Required + +```java +public java.lang.String getOrganizationSlug(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### ActionsOrganizationWorkflowPermissionsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.actions_organization_workflow_permissions.ActionsOrganizationWorkflowPermissionsConfig; + +ActionsOrganizationWorkflowPermissionsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .organizationSlug(java.lang.String) +// .canApprovePullRequestReviews(java.lang.Boolean|IResolvable) +// .defaultWorkflowPermissions(java.lang.String) +// .id(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 | *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 | *No description.* | +| organizationSlug | java.lang.String | The slug of the Organization. | +| canApprovePullRequestReviews | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether GitHub Actions can approve pull request reviews in any repository in the organization. | +| defaultWorkflowPermissions | java.lang.String | The default workflow permissions granted to the GITHUB_TOKEN when running workflows in any repository in the organization. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_workflow_permissions#id ActionsOrganizationWorkflowPermissions#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `organizationSlug`Required + +```java +public java.lang.String getOrganizationSlug(); +``` + +- *Type:* java.lang.String + +The slug of the Organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_workflow_permissions#organization_slug ActionsOrganizationWorkflowPermissions#organization_slug} + +--- + +##### `canApprovePullRequestReviews`Optional + +```java +public java.lang.Boolean|IResolvable getCanApprovePullRequestReviews(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether GitHub Actions can approve pull request reviews in any repository in the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_workflow_permissions#can_approve_pull_request_reviews ActionsOrganizationWorkflowPermissions#can_approve_pull_request_reviews} + +--- + +##### `defaultWorkflowPermissions`Optional + +```java +public java.lang.String getDefaultWorkflowPermissions(); +``` + +- *Type:* java.lang.String + +The default workflow permissions granted to the GITHUB_TOKEN when running workflows in any repository in the organization. + +Can be 'read' or 'write'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_organization_workflow_permissions#default_workflow_permissions ActionsOrganizationWorkflowPermissions#default_workflow_permissions} + +--- + +##### `id`Optional + +```java +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/resources/actions_organization_workflow_permissions#id ActionsOrganizationWorkflowPermissions#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. + +--- + + + diff --git a/docs/actionsRepositoryAccessLevel.csharp.md b/docs/actionsRepositoryAccessLevel.csharp.md new file mode 100644 index 000000000..f66e919e7 --- /dev/null +++ b/docs/actionsRepositoryAccessLevel.csharp.md @@ -0,0 +1,914 @@ +# `actionsRepositoryAccessLevel` Submodule + +## Constructs + +### ActionsRepositoryAccessLevel + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_access_level github_actions_repository_access_level}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsRepositoryAccessLevel(Construct Scope, string Id, ActionsRepositoryAccessLevelConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | ActionsRepositoryAccessLevelConfig | *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:* ActionsRepositoryAccessLevelConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a ActionsRepositoryAccessLevel resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsRepositoryAccessLevel.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` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsRepositoryAccessLevel.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsRepositoryAccessLevel.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsRepositoryAccessLevel.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a ActionsRepositoryAccessLevel resource upon running "cdktn 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 ActionsRepositoryAccessLevel to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing ActionsRepositoryAccessLevel that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_access_level#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the ActionsRepositoryAccessLevel to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| AccessLevelInput | string | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| AccessLevel | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `AccessLevelInput`Optional + +```csharp +public string AccessLevelInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `AccessLevel`Required + +```csharp +public string AccessLevel { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### ActionsRepositoryAccessLevelConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsRepositoryAccessLevelConfig { + 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 AccessLevel, + string Repository, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| AccessLevel | string | Where the actions or reusable workflows of the repository may be used. | +| Repository | string | The GitHub repository. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_access_level#id ActionsRepositoryAccessLevel#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `AccessLevel`Required + +```csharp +public string AccessLevel { get; set; } +``` + +- *Type:* string + +Where the actions or reusable workflows of the repository may be used. + +Possible values are 'none', 'user', 'organization', or 'enterprise'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_access_level#access_level ActionsRepositoryAccessLevel#access_level} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_access_level#repository ActionsRepositoryAccessLevel#repository} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_access_level#id ActionsRepositoryAccessLevel#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. + +--- + + + diff --git a/docs/actionsRepositoryAccessLevel.java.md b/docs/actionsRepositoryAccessLevel.java.md new file mode 100644 index 000000000..f1a25db28 --- /dev/null +++ b/docs/actionsRepositoryAccessLevel.java.md @@ -0,0 +1,1005 @@ +# `actionsRepositoryAccessLevel` Submodule + +## Constructs + +### ActionsRepositoryAccessLevel + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_access_level github_actions_repository_access_level}. + +#### Initializers + +```java +import io.cdktn.providers.github.actions_repository_access_level.ActionsRepositoryAccessLevel; + +ActionsRepositoryAccessLevel.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .accessLevel(java.lang.String) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| accessLevel | java.lang.String | Where the actions or reusable workflows of the repository may be used. | +| repository | java.lang.String | The GitHub repository. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_access_level#id ActionsRepositoryAccessLevel#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `accessLevel`Required + +- *Type:* java.lang.String + +Where the actions or reusable workflows of the repository may be used. + +Possible values are 'none', 'user', 'organization', or 'enterprise'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_access_level#access_level ActionsRepositoryAccessLevel#access_level} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_access_level#repository ActionsRepositoryAccessLevel#repository} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_access_level#id ActionsRepositoryAccessLevel#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a ActionsRepositoryAccessLevel resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.actions_repository_access_level.ActionsRepositoryAccessLevel; + +ActionsRepositoryAccessLevel.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` + +```java +import io.cdktn.providers.github.actions_repository_access_level.ActionsRepositoryAccessLevel; + +ActionsRepositoryAccessLevel.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.actions_repository_access_level.ActionsRepositoryAccessLevel; + +ActionsRepositoryAccessLevel.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.actions_repository_access_level.ActionsRepositoryAccessLevel; + +ActionsRepositoryAccessLevel.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ActionsRepositoryAccessLevel.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a ActionsRepositoryAccessLevel 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 ActionsRepositoryAccessLevel to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing ActionsRepositoryAccessLevel that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_access_level#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 ActionsRepositoryAccessLevel 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| accessLevelInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| accessLevel | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `accessLevelInput`Optional + +```java +public java.lang.String getAccessLevelInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `accessLevel`Required + +```java +public java.lang.String getAccessLevel(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### ActionsRepositoryAccessLevelConfig + +#### Initializer + +```java +import io.cdktn.providers.github.actions_repository_access_level.ActionsRepositoryAccessLevelConfig; + +ActionsRepositoryAccessLevelConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .accessLevel(java.lang.String) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| accessLevel | java.lang.String | Where the actions or reusable workflows of the repository may be used. | +| repository | java.lang.String | The GitHub repository. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_access_level#id ActionsRepositoryAccessLevel#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `accessLevel`Required + +```java +public java.lang.String getAccessLevel(); +``` + +- *Type:* java.lang.String + +Where the actions or reusable workflows of the repository may be used. + +Possible values are 'none', 'user', 'organization', or 'enterprise'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_access_level#access_level ActionsRepositoryAccessLevel#access_level} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_access_level#repository ActionsRepositoryAccessLevel#repository} + +--- + +##### `id`Optional + +```java +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/resources/actions_repository_access_level#id ActionsRepositoryAccessLevel#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. + +--- + + + diff --git a/docs/actionsRepositoryOidcSubjectClaimCustomizationTemplate.csharp.md b/docs/actionsRepositoryOidcSubjectClaimCustomizationTemplate.csharp.md new file mode 100644 index 000000000..dd700bf7f --- /dev/null +++ b/docs/actionsRepositoryOidcSubjectClaimCustomizationTemplate.csharp.md @@ -0,0 +1,957 @@ +# `actionsRepositoryOidcSubjectClaimCustomizationTemplate` Submodule + +## Constructs + +### ActionsRepositoryOidcSubjectClaimCustomizationTemplate + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_oidc_subject_claim_customization_template github_actions_repository_oidc_subject_claim_customization_template}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsRepositoryOidcSubjectClaimCustomizationTemplate(Construct Scope, string Id, ActionsRepositoryOidcSubjectClaimCustomizationTemplateConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | ActionsRepositoryOidcSubjectClaimCustomizationTemplateConfig | *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:* ActionsRepositoryOidcSubjectClaimCustomizationTemplateConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | +| ResetIncludeClaimKeys | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetIncludeClaimKeys` + +```csharp +private void ResetIncludeClaimKeys() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a ActionsRepositoryOidcSubjectClaimCustomizationTemplate resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsRepositoryOidcSubjectClaimCustomizationTemplate.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` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsRepositoryOidcSubjectClaimCustomizationTemplate.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsRepositoryOidcSubjectClaimCustomizationTemplate.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsRepositoryOidcSubjectClaimCustomizationTemplate.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a ActionsRepositoryOidcSubjectClaimCustomizationTemplate resource upon running "cdktn 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 ActionsRepositoryOidcSubjectClaimCustomizationTemplate to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing ActionsRepositoryOidcSubjectClaimCustomizationTemplate that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_oidc_subject_claim_customization_template#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the ActionsRepositoryOidcSubjectClaimCustomizationTemplate to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| IdInput | string | *No description.* | +| IncludeClaimKeysInput | string[] | *No description.* | +| RepositoryInput | string | *No description.* | +| UseDefaultInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| Id | string | *No description.* | +| IncludeClaimKeys | string[] | *No description.* | +| Repository | string | *No description.* | +| UseDefault | bool\|Io.Cdktn.IResolvable | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `IncludeClaimKeysInput`Optional + +```csharp +public string[] IncludeClaimKeysInput { get; } +``` + +- *Type:* string[] + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `UseDefaultInput`Optional + +```csharp +public bool|IResolvable UseDefaultInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `IncludeClaimKeys`Required + +```csharp +public string[] IncludeClaimKeys { get; } +``` + +- *Type:* string[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `UseDefault`Required + +```csharp +public bool|IResolvable UseDefault { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### ActionsRepositoryOidcSubjectClaimCustomizationTemplateConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsRepositoryOidcSubjectClaimCustomizationTemplateConfig { + 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 Repository, + bool|IResolvable UseDefault, + string Id = null, + string[] IncludeClaimKeys = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | The name of the repository. | +| UseDefault | bool\|Io.Cdktn.IResolvable | Whether to use the default template or not. If 'true', 'include_claim_keys' must not be set. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_oidc_subject_claim_customization_template#id ActionsRepositoryOidcSubjectClaimCustomizationTemplate#id}. | +| IncludeClaimKeys | string[] | A list of OpenID Connect claims. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_oidc_subject_claim_customization_template#repository ActionsRepositoryOidcSubjectClaimCustomizationTemplate#repository} + +--- + +##### `UseDefault`Required + +```csharp +public bool|IResolvable UseDefault { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether to use the default template or not. If 'true', 'include_claim_keys' must not be set. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_oidc_subject_claim_customization_template#use_default ActionsRepositoryOidcSubjectClaimCustomizationTemplate#use_default} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_oidc_subject_claim_customization_template#id ActionsRepositoryOidcSubjectClaimCustomizationTemplate#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. + +--- + +##### `IncludeClaimKeys`Optional + +```csharp +public string[] IncludeClaimKeys { get; set; } +``` + +- *Type:* string[] + +A list of OpenID Connect claims. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_oidc_subject_claim_customization_template#include_claim_keys ActionsRepositoryOidcSubjectClaimCustomizationTemplate#include_claim_keys} + +--- + + + diff --git a/docs/actionsRepositoryOidcSubjectClaimCustomizationTemplate.java.md b/docs/actionsRepositoryOidcSubjectClaimCustomizationTemplate.java.md new file mode 100644 index 000000000..858f2aca7 --- /dev/null +++ b/docs/actionsRepositoryOidcSubjectClaimCustomizationTemplate.java.md @@ -0,0 +1,1058 @@ +# `actionsRepositoryOidcSubjectClaimCustomizationTemplate` Submodule + +## Constructs + +### ActionsRepositoryOidcSubjectClaimCustomizationTemplate + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_oidc_subject_claim_customization_template github_actions_repository_oidc_subject_claim_customization_template}. + +#### Initializers + +```java +import io.cdktn.providers.github.actions_repository_oidc_subject_claim_customization_template.ActionsRepositoryOidcSubjectClaimCustomizationTemplate; + +ActionsRepositoryOidcSubjectClaimCustomizationTemplate.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) + .useDefault(java.lang.Boolean|IResolvable) +// .id(java.lang.String) +// .includeClaimKeys(java.util.List) + .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 | *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 | *No description.* | +| repository | java.lang.String | The name of the repository. | +| useDefault | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether to use the default template or not. If 'true', 'include_claim_keys' must not be set. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_oidc_subject_claim_customization_template#id ActionsRepositoryOidcSubjectClaimCustomizationTemplate#id}. | +| includeClaimKeys | java.util.List | A list of OpenID Connect claims. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_oidc_subject_claim_customization_template#repository ActionsRepositoryOidcSubjectClaimCustomizationTemplate#repository} + +--- + +##### `useDefault`Required + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether to use the default template or not. If 'true', 'include_claim_keys' must not be set. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_oidc_subject_claim_customization_template#use_default ActionsRepositoryOidcSubjectClaimCustomizationTemplate#use_default} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_oidc_subject_claim_customization_template#id ActionsRepositoryOidcSubjectClaimCustomizationTemplate#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. + +--- + +##### `includeClaimKeys`Optional + +- *Type:* java.util.List + +A list of OpenID Connect claims. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_oidc_subject_claim_customization_template#include_claim_keys ActionsRepositoryOidcSubjectClaimCustomizationTemplate#include_claim_keys} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | +| resetIncludeClaimKeys | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetIncludeClaimKeys` + +```java +public void resetIncludeClaimKeys() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a ActionsRepositoryOidcSubjectClaimCustomizationTemplate resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.actions_repository_oidc_subject_claim_customization_template.ActionsRepositoryOidcSubjectClaimCustomizationTemplate; + +ActionsRepositoryOidcSubjectClaimCustomizationTemplate.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` + +```java +import io.cdktn.providers.github.actions_repository_oidc_subject_claim_customization_template.ActionsRepositoryOidcSubjectClaimCustomizationTemplate; + +ActionsRepositoryOidcSubjectClaimCustomizationTemplate.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.actions_repository_oidc_subject_claim_customization_template.ActionsRepositoryOidcSubjectClaimCustomizationTemplate; + +ActionsRepositoryOidcSubjectClaimCustomizationTemplate.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.actions_repository_oidc_subject_claim_customization_template.ActionsRepositoryOidcSubjectClaimCustomizationTemplate; + +ActionsRepositoryOidcSubjectClaimCustomizationTemplate.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ActionsRepositoryOidcSubjectClaimCustomizationTemplate.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a ActionsRepositoryOidcSubjectClaimCustomizationTemplate 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 ActionsRepositoryOidcSubjectClaimCustomizationTemplate to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing ActionsRepositoryOidcSubjectClaimCustomizationTemplate that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_oidc_subject_claim_customization_template#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 ActionsRepositoryOidcSubjectClaimCustomizationTemplate 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| idInput | java.lang.String | *No description.* | +| includeClaimKeysInput | java.util.List | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| useDefaultInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| id | java.lang.String | *No description.* | +| includeClaimKeys | java.util.List | *No description.* | +| repository | java.lang.String | *No description.* | +| useDefault | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `includeClaimKeysInput`Optional + +```java +public java.util.List getIncludeClaimKeysInput(); +``` + +- *Type:* java.util.List + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `useDefaultInput`Optional + +```java +public java.lang.Boolean|IResolvable getUseDefaultInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `includeClaimKeys`Required + +```java +public java.util.List getIncludeClaimKeys(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `useDefault`Required + +```java +public java.lang.Boolean|IResolvable getUseDefault(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### ActionsRepositoryOidcSubjectClaimCustomizationTemplateConfig + +#### Initializer + +```java +import io.cdktn.providers.github.actions_repository_oidc_subject_claim_customization_template.ActionsRepositoryOidcSubjectClaimCustomizationTemplateConfig; + +ActionsRepositoryOidcSubjectClaimCustomizationTemplateConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) + .useDefault(java.lang.Boolean|IResolvable) +// .id(java.lang.String) +// .includeClaimKeys(java.util.List) + .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 | *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 | *No description.* | +| repository | java.lang.String | The name of the repository. | +| useDefault | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether to use the default template or not. If 'true', 'include_claim_keys' must not be set. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_oidc_subject_claim_customization_template#id ActionsRepositoryOidcSubjectClaimCustomizationTemplate#id}. | +| includeClaimKeys | java.util.List | A list of OpenID Connect claims. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_oidc_subject_claim_customization_template#repository ActionsRepositoryOidcSubjectClaimCustomizationTemplate#repository} + +--- + +##### `useDefault`Required + +```java +public java.lang.Boolean|IResolvable getUseDefault(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether to use the default template or not. If 'true', 'include_claim_keys' must not be set. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_oidc_subject_claim_customization_template#use_default ActionsRepositoryOidcSubjectClaimCustomizationTemplate#use_default} + +--- + +##### `id`Optional + +```java +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/resources/actions_repository_oidc_subject_claim_customization_template#id ActionsRepositoryOidcSubjectClaimCustomizationTemplate#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. + +--- + +##### `includeClaimKeys`Optional + +```java +public java.util.List getIncludeClaimKeys(); +``` + +- *Type:* java.util.List + +A list of OpenID Connect claims. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_oidc_subject_claim_customization_template#include_claim_keys ActionsRepositoryOidcSubjectClaimCustomizationTemplate#include_claim_keys} + +--- + + + diff --git a/docs/actionsRepositoryPermissions.csharp.md b/docs/actionsRepositoryPermissions.csharp.md new file mode 100644 index 000000000..97f4c58b9 --- /dev/null +++ b/docs/actionsRepositoryPermissions.csharp.md @@ -0,0 +1,1469 @@ +# `actionsRepositoryPermissions` Submodule + +## Constructs + +### ActionsRepositoryPermissions + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions github_actions_repository_permissions}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsRepositoryPermissions(Construct Scope, string Id, ActionsRepositoryPermissionsConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | ActionsRepositoryPermissionsConfig | *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:* ActionsRepositoryPermissionsConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| PutAllowedActionsConfig | *No description.* | +| ResetAllowedActions | *No description.* | +| ResetAllowedActionsConfig | *No description.* | +| ResetEnabled | *No description.* | +| ResetId | *No description.* | +| ResetShaPinningRequired | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `PutAllowedActionsConfig` + +```csharp +private void PutAllowedActionsConfig(ActionsRepositoryPermissionsAllowedActionsConfig Value) +``` + +###### `Value`Required + +- *Type:* ActionsRepositoryPermissionsAllowedActionsConfig + +--- + +##### `ResetAllowedActions` + +```csharp +private void ResetAllowedActions() +``` + +##### `ResetAllowedActionsConfig` + +```csharp +private void ResetAllowedActionsConfig() +``` + +##### `ResetEnabled` + +```csharp +private void ResetEnabled() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetShaPinningRequired` + +```csharp +private void ResetShaPinningRequired() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a ActionsRepositoryPermissions resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsRepositoryPermissions.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` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsRepositoryPermissions.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsRepositoryPermissions.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsRepositoryPermissions.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a ActionsRepositoryPermissions resource upon running "cdktn 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 ActionsRepositoryPermissions to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing ActionsRepositoryPermissions that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the ActionsRepositoryPermissions to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| AllowedActionsConfig | ActionsRepositoryPermissionsAllowedActionsConfigOutputReference | *No description.* | +| AllowedActionsConfigInput | ActionsRepositoryPermissionsAllowedActionsConfig | *No description.* | +| AllowedActionsInput | string | *No description.* | +| EnabledInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| ShaPinningRequiredInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| AllowedActions | string | *No description.* | +| Enabled | bool\|Io.Cdktn.IResolvable | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | +| ShaPinningRequired | bool\|Io.Cdktn.IResolvable | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `AllowedActionsConfig`Required + +```csharp +public ActionsRepositoryPermissionsAllowedActionsConfigOutputReference AllowedActionsConfig { get; } +``` + +- *Type:* ActionsRepositoryPermissionsAllowedActionsConfigOutputReference + +--- + +##### `AllowedActionsConfigInput`Optional + +```csharp +public ActionsRepositoryPermissionsAllowedActionsConfig AllowedActionsConfigInput { get; } +``` + +- *Type:* ActionsRepositoryPermissionsAllowedActionsConfig + +--- + +##### `AllowedActionsInput`Optional + +```csharp +public string AllowedActionsInput { get; } +``` + +- *Type:* string + +--- + +##### `EnabledInput`Optional + +```csharp +public bool|IResolvable EnabledInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `ShaPinningRequiredInput`Optional + +```csharp +public bool|IResolvable ShaPinningRequiredInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `AllowedActions`Required + +```csharp +public string AllowedActions { get; } +``` + +- *Type:* string + +--- + +##### `Enabled`Required + +```csharp +public bool|IResolvable Enabled { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `ShaPinningRequired`Required + +```csharp +public bool|IResolvable ShaPinningRequired { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### ActionsRepositoryPermissionsAllowedActionsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsRepositoryPermissionsAllowedActionsConfig { + bool|IResolvable GithubOwnedAllowed, + string[] PatternsAllowed = null, + bool|IResolvable VerifiedAllowed = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GithubOwnedAllowed | bool\|Io.Cdktn.IResolvable | Whether GitHub-owned actions are allowed in the repository. | +| PatternsAllowed | string[] | Specifies a list of string-matching patterns to allow specific action(s). | +| VerifiedAllowed | bool\|Io.Cdktn.IResolvable | Whether actions in GitHub Marketplace from verified creators are allowed. | + +--- + +##### `GithubOwnedAllowed`Required + +```csharp +public bool|IResolvable GithubOwnedAllowed { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether GitHub-owned actions are allowed in the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#github_owned_allowed ActionsRepositoryPermissions#github_owned_allowed} + +--- + +##### `PatternsAllowed`Optional + +```csharp +public string[] PatternsAllowed { get; set; } +``` + +- *Type:* string[] + +Specifies a list of string-matching patterns to allow specific action(s). + +Wildcards, tags, and SHAs are allowed. For example, 'monalisa/octocat@', 'monalisa/octocat@v2', 'monalisa/'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#patterns_allowed ActionsRepositoryPermissions#patterns_allowed} + +--- + +##### `VerifiedAllowed`Optional + +```csharp +public bool|IResolvable VerifiedAllowed { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether actions in GitHub Marketplace from verified creators are allowed. + +Set to 'true' to allow all GitHub Marketplace actions by verified creators. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#verified_allowed ActionsRepositoryPermissions#verified_allowed} + +--- + +### ActionsRepositoryPermissionsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsRepositoryPermissionsConfig { + 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 Repository, + string AllowedActions = null, + ActionsRepositoryPermissionsAllowedActionsConfig AllowedActionsConfig = null, + bool|IResolvable Enabled = null, + string Id = null, + bool|IResolvable ShaPinningRequired = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | The GitHub repository. | +| AllowedActions | string | The permissions policy that controls the actions that are allowed to run. | +| AllowedActionsConfig | ActionsRepositoryPermissionsAllowedActionsConfig | allowed_actions_config block. | +| Enabled | bool\|Io.Cdktn.IResolvable | Should GitHub actions be enabled on this repository. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#id ActionsRepositoryPermissions#id}. | +| ShaPinningRequired | bool\|Io.Cdktn.IResolvable | Whether pinning to a specific SHA is required for all actions and reusable workflows in a repository. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#repository ActionsRepositoryPermissions#repository} + +--- + +##### `AllowedActions`Optional + +```csharp +public string AllowedActions { get; set; } +``` + +- *Type:* string + +The permissions policy that controls the actions that are allowed to run. + +Can be one of: 'all', 'local_only', or 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#allowed_actions ActionsRepositoryPermissions#allowed_actions} + +--- + +##### `AllowedActionsConfig`Optional + +```csharp +public ActionsRepositoryPermissionsAllowedActionsConfig AllowedActionsConfig { get; set; } +``` + +- *Type:* ActionsRepositoryPermissionsAllowedActionsConfig + +allowed_actions_config block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#allowed_actions_config ActionsRepositoryPermissions#allowed_actions_config} + +--- + +##### `Enabled`Optional + +```csharp +public bool|IResolvable Enabled { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Should GitHub actions be enabled on this repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#enabled ActionsRepositoryPermissions#enabled} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#id ActionsRepositoryPermissions#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. + +--- + +##### `ShaPinningRequired`Optional + +```csharp +public bool|IResolvable ShaPinningRequired { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether pinning to a specific SHA is required for all actions and reusable workflows in a repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#sha_pinning_required ActionsRepositoryPermissions#sha_pinning_required} + +--- + +## Classes + +### ActionsRepositoryPermissionsAllowedActionsConfigOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsRepositoryPermissionsAllowedActionsConfigOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetPatternsAllowed | *No description.* | +| ResetVerifiedAllowed | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetPatternsAllowed` + +```csharp +private void ResetPatternsAllowed() +``` + +##### `ResetVerifiedAllowed` + +```csharp +private void ResetVerifiedAllowed() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| GithubOwnedAllowedInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| PatternsAllowedInput | string[] | *No description.* | +| VerifiedAllowedInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| GithubOwnedAllowed | bool\|Io.Cdktn.IResolvable | *No description.* | +| PatternsAllowed | string[] | *No description.* | +| VerifiedAllowed | bool\|Io.Cdktn.IResolvable | *No description.* | +| InternalValue | ActionsRepositoryPermissionsAllowedActionsConfig | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `GithubOwnedAllowedInput`Optional + +```csharp +public bool|IResolvable GithubOwnedAllowedInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `PatternsAllowedInput`Optional + +```csharp +public string[] PatternsAllowedInput { get; } +``` + +- *Type:* string[] + +--- + +##### `VerifiedAllowedInput`Optional + +```csharp +public bool|IResolvable VerifiedAllowedInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `GithubOwnedAllowed`Required + +```csharp +public bool|IResolvable GithubOwnedAllowed { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `PatternsAllowed`Required + +```csharp +public string[] PatternsAllowed { get; } +``` + +- *Type:* string[] + +--- + +##### `VerifiedAllowed`Required + +```csharp +public bool|IResolvable VerifiedAllowed { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `InternalValue`Optional + +```csharp +public ActionsRepositoryPermissionsAllowedActionsConfig InternalValue { get; } +``` + +- *Type:* ActionsRepositoryPermissionsAllowedActionsConfig + +--- + + + diff --git a/docs/actionsRepositoryPermissions.java.md b/docs/actionsRepositoryPermissions.java.md new file mode 100644 index 000000000..49870a64d --- /dev/null +++ b/docs/actionsRepositoryPermissions.java.md @@ -0,0 +1,1596 @@ +# `actionsRepositoryPermissions` Submodule + +## Constructs + +### ActionsRepositoryPermissions + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions github_actions_repository_permissions}. + +#### Initializers + +```java +import io.cdktn.providers.github.actions_repository_permissions.ActionsRepositoryPermissions; + +ActionsRepositoryPermissions.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .allowedActions(java.lang.String) +// .allowedActionsConfig(ActionsRepositoryPermissionsAllowedActionsConfig) +// .enabled(java.lang.Boolean|IResolvable) +// .id(java.lang.String) +// .shaPinningRequired(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 | *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 | *No description.* | +| repository | java.lang.String | The GitHub repository. | +| allowedActions | java.lang.String | The permissions policy that controls the actions that are allowed to run. | +| allowedActionsConfig | ActionsRepositoryPermissionsAllowedActionsConfig | allowed_actions_config block. | +| enabled | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Should GitHub actions be enabled on this repository. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#id ActionsRepositoryPermissions#id}. | +| shaPinningRequired | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether pinning to a specific SHA is required for all actions and reusable workflows in a repository. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#repository ActionsRepositoryPermissions#repository} + +--- + +##### `allowedActions`Optional + +- *Type:* java.lang.String + +The permissions policy that controls the actions that are allowed to run. + +Can be one of: 'all', 'local_only', or 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#allowed_actions ActionsRepositoryPermissions#allowed_actions} + +--- + +##### `allowedActionsConfig`Optional + +- *Type:* ActionsRepositoryPermissionsAllowedActionsConfig + +allowed_actions_config block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#allowed_actions_config ActionsRepositoryPermissions#allowed_actions_config} + +--- + +##### `enabled`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Should GitHub actions be enabled on this repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#enabled ActionsRepositoryPermissions#enabled} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#id ActionsRepositoryPermissions#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. + +--- + +##### `shaPinningRequired`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether pinning to a specific SHA is required for all actions and reusable workflows in a repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#sha_pinning_required ActionsRepositoryPermissions#sha_pinning_required} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| putAllowedActionsConfig | *No description.* | +| resetAllowedActions | *No description.* | +| resetAllowedActionsConfig | *No description.* | +| resetEnabled | *No description.* | +| resetId | *No description.* | +| resetShaPinningRequired | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `putAllowedActionsConfig` + +```java +public void putAllowedActionsConfig(ActionsRepositoryPermissionsAllowedActionsConfig value) +``` + +###### `value`Required + +- *Type:* ActionsRepositoryPermissionsAllowedActionsConfig + +--- + +##### `resetAllowedActions` + +```java +public void resetAllowedActions() +``` + +##### `resetAllowedActionsConfig` + +```java +public void resetAllowedActionsConfig() +``` + +##### `resetEnabled` + +```java +public void resetEnabled() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetShaPinningRequired` + +```java +public void resetShaPinningRequired() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a ActionsRepositoryPermissions resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.actions_repository_permissions.ActionsRepositoryPermissions; + +ActionsRepositoryPermissions.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` + +```java +import io.cdktn.providers.github.actions_repository_permissions.ActionsRepositoryPermissions; + +ActionsRepositoryPermissions.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.actions_repository_permissions.ActionsRepositoryPermissions; + +ActionsRepositoryPermissions.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.actions_repository_permissions.ActionsRepositoryPermissions; + +ActionsRepositoryPermissions.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ActionsRepositoryPermissions.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a ActionsRepositoryPermissions 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 ActionsRepositoryPermissions to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing ActionsRepositoryPermissions that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#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 ActionsRepositoryPermissions 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| allowedActionsConfig | ActionsRepositoryPermissionsAllowedActionsConfigOutputReference | *No description.* | +| allowedActionsConfigInput | ActionsRepositoryPermissionsAllowedActionsConfig | *No description.* | +| allowedActionsInput | java.lang.String | *No description.* | +| enabledInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| shaPinningRequiredInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| allowedActions | java.lang.String | *No description.* | +| enabled | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | +| shaPinningRequired | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `allowedActionsConfig`Required + +```java +public ActionsRepositoryPermissionsAllowedActionsConfigOutputReference getAllowedActionsConfig(); +``` + +- *Type:* ActionsRepositoryPermissionsAllowedActionsConfigOutputReference + +--- + +##### `allowedActionsConfigInput`Optional + +```java +public ActionsRepositoryPermissionsAllowedActionsConfig getAllowedActionsConfigInput(); +``` + +- *Type:* ActionsRepositoryPermissionsAllowedActionsConfig + +--- + +##### `allowedActionsInput`Optional + +```java +public java.lang.String getAllowedActionsInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `enabledInput`Optional + +```java +public java.lang.Boolean|IResolvable getEnabledInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `shaPinningRequiredInput`Optional + +```java +public java.lang.Boolean|IResolvable getShaPinningRequiredInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `allowedActions`Required + +```java +public java.lang.String getAllowedActions(); +``` + +- *Type:* java.lang.String + +--- + +##### `enabled`Required + +```java +public java.lang.Boolean|IResolvable getEnabled(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `shaPinningRequired`Required + +```java +public java.lang.Boolean|IResolvable getShaPinningRequired(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### ActionsRepositoryPermissionsAllowedActionsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.actions_repository_permissions.ActionsRepositoryPermissionsAllowedActionsConfig; + +ActionsRepositoryPermissionsAllowedActionsConfig.builder() + .githubOwnedAllowed(java.lang.Boolean|IResolvable) +// .patternsAllowed(java.util.List) +// .verifiedAllowed(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| githubOwnedAllowed | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether GitHub-owned actions are allowed in the repository. | +| patternsAllowed | java.util.List | Specifies a list of string-matching patterns to allow specific action(s). | +| verifiedAllowed | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether actions in GitHub Marketplace from verified creators are allowed. | + +--- + +##### `githubOwnedAllowed`Required + +```java +public java.lang.Boolean|IResolvable getGithubOwnedAllowed(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether GitHub-owned actions are allowed in the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#github_owned_allowed ActionsRepositoryPermissions#github_owned_allowed} + +--- + +##### `patternsAllowed`Optional + +```java +public java.util.List getPatternsAllowed(); +``` + +- *Type:* java.util.List + +Specifies a list of string-matching patterns to allow specific action(s). + +Wildcards, tags, and SHAs are allowed. For example, 'monalisa/octocat@', 'monalisa/octocat@v2', 'monalisa/'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#patterns_allowed ActionsRepositoryPermissions#patterns_allowed} + +--- + +##### `verifiedAllowed`Optional + +```java +public java.lang.Boolean|IResolvable getVerifiedAllowed(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether actions in GitHub Marketplace from verified creators are allowed. + +Set to 'true' to allow all GitHub Marketplace actions by verified creators. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#verified_allowed ActionsRepositoryPermissions#verified_allowed} + +--- + +### ActionsRepositoryPermissionsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.actions_repository_permissions.ActionsRepositoryPermissionsConfig; + +ActionsRepositoryPermissionsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .allowedActions(java.lang.String) +// .allowedActionsConfig(ActionsRepositoryPermissionsAllowedActionsConfig) +// .enabled(java.lang.Boolean|IResolvable) +// .id(java.lang.String) +// .shaPinningRequired(java.lang.Boolean|IResolvable) + .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 | *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 | *No description.* | +| repository | java.lang.String | The GitHub repository. | +| allowedActions | java.lang.String | The permissions policy that controls the actions that are allowed to run. | +| allowedActionsConfig | ActionsRepositoryPermissionsAllowedActionsConfig | allowed_actions_config block. | +| enabled | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Should GitHub actions be enabled on this repository. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#id ActionsRepositoryPermissions#id}. | +| shaPinningRequired | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether pinning to a specific SHA is required for all actions and reusable workflows in a repository. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#repository ActionsRepositoryPermissions#repository} + +--- + +##### `allowedActions`Optional + +```java +public java.lang.String getAllowedActions(); +``` + +- *Type:* java.lang.String + +The permissions policy that controls the actions that are allowed to run. + +Can be one of: 'all', 'local_only', or 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#allowed_actions ActionsRepositoryPermissions#allowed_actions} + +--- + +##### `allowedActionsConfig`Optional + +```java +public ActionsRepositoryPermissionsAllowedActionsConfig getAllowedActionsConfig(); +``` + +- *Type:* ActionsRepositoryPermissionsAllowedActionsConfig + +allowed_actions_config block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#allowed_actions_config ActionsRepositoryPermissions#allowed_actions_config} + +--- + +##### `enabled`Optional + +```java +public java.lang.Boolean|IResolvable getEnabled(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Should GitHub actions be enabled on this repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#enabled ActionsRepositoryPermissions#enabled} + +--- + +##### `id`Optional + +```java +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/resources/actions_repository_permissions#id ActionsRepositoryPermissions#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. + +--- + +##### `shaPinningRequired`Optional + +```java +public java.lang.Boolean|IResolvable getShaPinningRequired(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether pinning to a specific SHA is required for all actions and reusable workflows in a repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_repository_permissions#sha_pinning_required ActionsRepositoryPermissions#sha_pinning_required} + +--- + +## Classes + +### ActionsRepositoryPermissionsAllowedActionsConfigOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.actions_repository_permissions.ActionsRepositoryPermissionsAllowedActionsConfigOutputReference; + +new ActionsRepositoryPermissionsAllowedActionsConfigOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetPatternsAllowed | *No description.* | +| resetVerifiedAllowed | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetPatternsAllowed` + +```java +public void resetPatternsAllowed() +``` + +##### `resetVerifiedAllowed` + +```java +public void resetVerifiedAllowed() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| githubOwnedAllowedInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| patternsAllowedInput | java.util.List | *No description.* | +| verifiedAllowedInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| githubOwnedAllowed | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| patternsAllowed | java.util.List | *No description.* | +| verifiedAllowed | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| internalValue | ActionsRepositoryPermissionsAllowedActionsConfig | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `githubOwnedAllowedInput`Optional + +```java +public java.lang.Boolean|IResolvable getGithubOwnedAllowedInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `patternsAllowedInput`Optional + +```java +public java.util.List getPatternsAllowedInput(); +``` + +- *Type:* java.util.List + +--- + +##### `verifiedAllowedInput`Optional + +```java +public java.lang.Boolean|IResolvable getVerifiedAllowedInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `githubOwnedAllowed`Required + +```java +public java.lang.Boolean|IResolvable getGithubOwnedAllowed(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `patternsAllowed`Required + +```java +public java.util.List getPatternsAllowed(); +``` + +- *Type:* java.util.List + +--- + +##### `verifiedAllowed`Required + +```java +public java.lang.Boolean|IResolvable getVerifiedAllowed(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `internalValue`Optional + +```java +public ActionsRepositoryPermissionsAllowedActionsConfig getInternalValue(); +``` + +- *Type:* ActionsRepositoryPermissionsAllowedActionsConfig + +--- + + + diff --git a/docs/actionsRunnerGroup.csharp.md b/docs/actionsRunnerGroup.csharp.md new file mode 100644 index 000000000..d142d7181 --- /dev/null +++ b/docs/actionsRunnerGroup.csharp.md @@ -0,0 +1,1116 @@ +# `actionsRunnerGroup` Submodule + +## Constructs + +### ActionsRunnerGroup + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_runner_group github_actions_runner_group}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsRunnerGroup(Construct Scope, string Id, ActionsRunnerGroupConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | ActionsRunnerGroupConfig | *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:* ActionsRunnerGroupConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetAllowsPublicRepositories | *No description.* | +| ResetRestrictedToWorkflows | *No description.* | +| ResetSelectedRepositoryIds | *No description.* | +| ResetSelectedWorkflows | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetAllowsPublicRepositories` + +```csharp +private void ResetAllowsPublicRepositories() +``` + +##### `ResetRestrictedToWorkflows` + +```csharp +private void ResetRestrictedToWorkflows() +``` + +##### `ResetSelectedRepositoryIds` + +```csharp +private void ResetSelectedRepositoryIds() +``` + +##### `ResetSelectedWorkflows` + +```csharp +private void ResetSelectedWorkflows() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a ActionsRunnerGroup resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsRunnerGroup.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` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsRunnerGroup.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsRunnerGroup.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsRunnerGroup.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a ActionsRunnerGroup resource upon running "cdktn 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 ActionsRunnerGroup to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing ActionsRunnerGroup that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_runner_group#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the ActionsRunnerGroup to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Default | Io.Cdktn.IResolvable | *No description.* | +| Etag | string | *No description.* | +| Id | string | *No description.* | +| Inherited | Io.Cdktn.IResolvable | *No description.* | +| RunnersUrl | string | *No description.* | +| SelectedRepositoriesUrl | string | *No description.* | +| AllowsPublicRepositoriesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| NameInput | string | *No description.* | +| RestrictedToWorkflowsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| SelectedRepositoryIdsInput | double[] | *No description.* | +| SelectedWorkflowsInput | string[] | *No description.* | +| VisibilityInput | string | *No description.* | +| AllowsPublicRepositories | bool\|Io.Cdktn.IResolvable | *No description.* | +| Name | string | *No description.* | +| RestrictedToWorkflows | bool\|Io.Cdktn.IResolvable | *No description.* | +| SelectedRepositoryIds | double[] | *No description.* | +| SelectedWorkflows | string[] | *No description.* | +| Visibility | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Default`Required + +```csharp +public IResolvable Default { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Inherited`Required + +```csharp +public IResolvable Inherited { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `RunnersUrl`Required + +```csharp +public string RunnersUrl { get; } +``` + +- *Type:* string + +--- + +##### `SelectedRepositoriesUrl`Required + +```csharp +public string SelectedRepositoriesUrl { get; } +``` + +- *Type:* string + +--- + +##### `AllowsPublicRepositoriesInput`Optional + +```csharp +public bool|IResolvable AllowsPublicRepositoriesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `RestrictedToWorkflowsInput`Optional + +```csharp +public bool|IResolvable RestrictedToWorkflowsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `SelectedRepositoryIdsInput`Optional + +```csharp +public double[] SelectedRepositoryIdsInput { get; } +``` + +- *Type:* double[] + +--- + +##### `SelectedWorkflowsInput`Optional + +```csharp +public string[] SelectedWorkflowsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `VisibilityInput`Optional + +```csharp +public string VisibilityInput { get; } +``` + +- *Type:* string + +--- + +##### `AllowsPublicRepositories`Required + +```csharp +public bool|IResolvable AllowsPublicRepositories { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `RestrictedToWorkflows`Required + +```csharp +public bool|IResolvable RestrictedToWorkflows { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `SelectedRepositoryIds`Required + +```csharp +public double[] SelectedRepositoryIds { get; } +``` + +- *Type:* double[] + +--- + +##### `SelectedWorkflows`Required + +```csharp +public string[] SelectedWorkflows { get; } +``` + +- *Type:* string[] + +--- + +##### `Visibility`Required + +```csharp +public string Visibility { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### ActionsRunnerGroupConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsRunnerGroupConfig { + 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 Name, + string Visibility, + bool|IResolvable AllowsPublicRepositories = null, + bool|IResolvable RestrictedToWorkflows = null, + double[] SelectedRepositoryIds = null, + string[] SelectedWorkflows = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Name | string | Name of the runner group. | +| Visibility | string | The visibility of the runner group. | +| AllowsPublicRepositories | bool\|Io.Cdktn.IResolvable | Whether public repositories can be added to the runner group. | +| RestrictedToWorkflows | bool\|Io.Cdktn.IResolvable | If 'true', the runner group will be restricted to running only the workflows specified in the 'selected_workflows' array. | +| SelectedRepositoryIds | double[] | List of repository IDs that can access the runner group. | +| SelectedWorkflows | string[] | List of workflows the runner group should be allowed to run. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Name`Required + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +Name of the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_runner_group#name ActionsRunnerGroup#name} + +--- + +##### `Visibility`Required + +```csharp +public string Visibility { get; set; } +``` + +- *Type:* string + +The visibility of the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_runner_group#visibility ActionsRunnerGroup#visibility} + +--- + +##### `AllowsPublicRepositories`Optional + +```csharp +public bool|IResolvable AllowsPublicRepositories { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether public repositories can be added to the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_runner_group#allows_public_repositories ActionsRunnerGroup#allows_public_repositories} + +--- + +##### `RestrictedToWorkflows`Optional + +```csharp +public bool|IResolvable RestrictedToWorkflows { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +If 'true', the runner group will be restricted to running only the workflows specified in the 'selected_workflows' array. + +Defaults to 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_runner_group#restricted_to_workflows ActionsRunnerGroup#restricted_to_workflows} + +--- + +##### `SelectedRepositoryIds`Optional + +```csharp +public double[] SelectedRepositoryIds { get; set; } +``` + +- *Type:* double[] + +List of repository IDs that can access the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_runner_group#selected_repository_ids ActionsRunnerGroup#selected_repository_ids} + +--- + +##### `SelectedWorkflows`Optional + +```csharp +public string[] SelectedWorkflows { get; set; } +``` + +- *Type:* string[] + +List of workflows the runner group should be allowed to run. + +This setting will be ignored unless restricted_to_workflows is set to 'true'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_runner_group#selected_workflows ActionsRunnerGroup#selected_workflows} + +--- + + + diff --git a/docs/actionsRunnerGroup.java.md b/docs/actionsRunnerGroup.java.md new file mode 100644 index 000000000..87df1cdbd --- /dev/null +++ b/docs/actionsRunnerGroup.java.md @@ -0,0 +1,1244 @@ +# `actionsRunnerGroup` Submodule + +## Constructs + +### ActionsRunnerGroup + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_runner_group github_actions_runner_group}. + +#### Initializers + +```java +import io.cdktn.providers.github.actions_runner_group.ActionsRunnerGroup; + +ActionsRunnerGroup.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .name(java.lang.String) + .visibility(java.lang.String) +// .allowsPublicRepositories(java.lang.Boolean|IResolvable) +// .restrictedToWorkflows(java.lang.Boolean|IResolvable) +// .selectedRepositoryIds(java.util.List) +// .selectedWorkflows(java.util.List) + .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 | *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 | *No description.* | +| name | java.lang.String | Name of the runner group. | +| visibility | java.lang.String | The visibility of the runner group. | +| allowsPublicRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether public repositories can be added to the runner group. | +| restrictedToWorkflows | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | If 'true', the runner group will be restricted to running only the workflows specified in the 'selected_workflows' array. | +| selectedRepositoryIds | java.util.List | List of repository IDs that can access the runner group. | +| selectedWorkflows | java.util.List | List of workflows the runner group should be allowed to run. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `name`Required + +- *Type:* java.lang.String + +Name of the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_runner_group#name ActionsRunnerGroup#name} + +--- + +##### `visibility`Required + +- *Type:* java.lang.String + +The visibility of the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_runner_group#visibility ActionsRunnerGroup#visibility} + +--- + +##### `allowsPublicRepositories`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether public repositories can be added to the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_runner_group#allows_public_repositories ActionsRunnerGroup#allows_public_repositories} + +--- + +##### `restrictedToWorkflows`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +If 'true', the runner group will be restricted to running only the workflows specified in the 'selected_workflows' array. + +Defaults to 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_runner_group#restricted_to_workflows ActionsRunnerGroup#restricted_to_workflows} + +--- + +##### `selectedRepositoryIds`Optional + +- *Type:* java.util.List + +List of repository IDs that can access the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_runner_group#selected_repository_ids ActionsRunnerGroup#selected_repository_ids} + +--- + +##### `selectedWorkflows`Optional + +- *Type:* java.util.List + +List of workflows the runner group should be allowed to run. + +This setting will be ignored unless restricted_to_workflows is set to 'true'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_runner_group#selected_workflows ActionsRunnerGroup#selected_workflows} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetAllowsPublicRepositories | *No description.* | +| resetRestrictedToWorkflows | *No description.* | +| resetSelectedRepositoryIds | *No description.* | +| resetSelectedWorkflows | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetAllowsPublicRepositories` + +```java +public void resetAllowsPublicRepositories() +``` + +##### `resetRestrictedToWorkflows` + +```java +public void resetRestrictedToWorkflows() +``` + +##### `resetSelectedRepositoryIds` + +```java +public void resetSelectedRepositoryIds() +``` + +##### `resetSelectedWorkflows` + +```java +public void resetSelectedWorkflows() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a ActionsRunnerGroup resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.actions_runner_group.ActionsRunnerGroup; + +ActionsRunnerGroup.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` + +```java +import io.cdktn.providers.github.actions_runner_group.ActionsRunnerGroup; + +ActionsRunnerGroup.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.actions_runner_group.ActionsRunnerGroup; + +ActionsRunnerGroup.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.actions_runner_group.ActionsRunnerGroup; + +ActionsRunnerGroup.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ActionsRunnerGroup.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a ActionsRunnerGroup 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 ActionsRunnerGroup to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing ActionsRunnerGroup that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_runner_group#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 ActionsRunnerGroup 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| default | io.cdktn.cdktn.IResolvable | *No description.* | +| etag | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| inherited | io.cdktn.cdktn.IResolvable | *No description.* | +| runnersUrl | java.lang.String | *No description.* | +| selectedRepositoriesUrl | java.lang.String | *No description.* | +| allowsPublicRepositoriesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| nameInput | java.lang.String | *No description.* | +| restrictedToWorkflowsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| selectedRepositoryIdsInput | java.util.List | *No description.* | +| selectedWorkflowsInput | java.util.List | *No description.* | +| visibilityInput | java.lang.String | *No description.* | +| allowsPublicRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| name | java.lang.String | *No description.* | +| restrictedToWorkflows | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| selectedRepositoryIds | java.util.List | *No description.* | +| selectedWorkflows | java.util.List | *No description.* | +| visibility | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `default`Required + +```java +public IResolvable getDefault(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `inherited`Required + +```java +public IResolvable getInherited(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `runnersUrl`Required + +```java +public java.lang.String getRunnersUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `selectedRepositoriesUrl`Required + +```java +public java.lang.String getSelectedRepositoriesUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `allowsPublicRepositoriesInput`Optional + +```java +public java.lang.Boolean|IResolvable getAllowsPublicRepositoriesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `restrictedToWorkflowsInput`Optional + +```java +public java.lang.Boolean|IResolvable getRestrictedToWorkflowsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `selectedRepositoryIdsInput`Optional + +```java +public java.util.List getSelectedRepositoryIdsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `selectedWorkflowsInput`Optional + +```java +public java.util.List getSelectedWorkflowsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `visibilityInput`Optional + +```java +public java.lang.String getVisibilityInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `allowsPublicRepositories`Required + +```java +public java.lang.Boolean|IResolvable getAllowsPublicRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `restrictedToWorkflows`Required + +```java +public java.lang.Boolean|IResolvable getRestrictedToWorkflows(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `selectedRepositoryIds`Required + +```java +public java.util.List getSelectedRepositoryIds(); +``` + +- *Type:* java.util.List + +--- + +##### `selectedWorkflows`Required + +```java +public java.util.List getSelectedWorkflows(); +``` + +- *Type:* java.util.List + +--- + +##### `visibility`Required + +```java +public java.lang.String getVisibility(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### ActionsRunnerGroupConfig + +#### Initializer + +```java +import io.cdktn.providers.github.actions_runner_group.ActionsRunnerGroupConfig; + +ActionsRunnerGroupConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .name(java.lang.String) + .visibility(java.lang.String) +// .allowsPublicRepositories(java.lang.Boolean|IResolvable) +// .restrictedToWorkflows(java.lang.Boolean|IResolvable) +// .selectedRepositoryIds(java.util.List) +// .selectedWorkflows(java.util.List) + .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 | *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 | *No description.* | +| name | java.lang.String | Name of the runner group. | +| visibility | java.lang.String | The visibility of the runner group. | +| allowsPublicRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether public repositories can be added to the runner group. | +| restrictedToWorkflows | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | If 'true', the runner group will be restricted to running only the workflows specified in the 'selected_workflows' array. | +| selectedRepositoryIds | java.util.List | List of repository IDs that can access the runner group. | +| selectedWorkflows | java.util.List | List of workflows the runner group should be allowed to run. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +Name of the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_runner_group#name ActionsRunnerGroup#name} + +--- + +##### `visibility`Required + +```java +public java.lang.String getVisibility(); +``` + +- *Type:* java.lang.String + +The visibility of the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_runner_group#visibility ActionsRunnerGroup#visibility} + +--- + +##### `allowsPublicRepositories`Optional + +```java +public java.lang.Boolean|IResolvable getAllowsPublicRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether public repositories can be added to the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_runner_group#allows_public_repositories ActionsRunnerGroup#allows_public_repositories} + +--- + +##### `restrictedToWorkflows`Optional + +```java +public java.lang.Boolean|IResolvable getRestrictedToWorkflows(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +If 'true', the runner group will be restricted to running only the workflows specified in the 'selected_workflows' array. + +Defaults to 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_runner_group#restricted_to_workflows ActionsRunnerGroup#restricted_to_workflows} + +--- + +##### `selectedRepositoryIds`Optional + +```java +public java.util.List getSelectedRepositoryIds(); +``` + +- *Type:* java.util.List + +List of repository IDs that can access the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_runner_group#selected_repository_ids ActionsRunnerGroup#selected_repository_ids} + +--- + +##### `selectedWorkflows`Optional + +```java +public java.util.List getSelectedWorkflows(); +``` + +- *Type:* java.util.List + +List of workflows the runner group should be allowed to run. + +This setting will be ignored unless restricted_to_workflows is set to 'true'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_runner_group#selected_workflows ActionsRunnerGroup#selected_workflows} + +--- + + + diff --git a/docs/actionsSecret.csharp.md b/docs/actionsSecret.csharp.md new file mode 100644 index 000000000..91554317a --- /dev/null +++ b/docs/actionsSecret.csharp.md @@ -0,0 +1,1224 @@ +# `actionsSecret` Submodule + +## Constructs + +### ActionsSecret + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret github_actions_secret}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsSecret(Construct Scope, string Id, ActionsSecretConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | ActionsSecretConfig | *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:* ActionsSecretConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetDestroyOnDrift | *No description.* | +| ResetEncryptedValue | *No description.* | +| ResetId | *No description.* | +| ResetKeyId | *No description.* | +| ResetPlaintextValue | *No description.* | +| ResetValue | *No description.* | +| ResetValueEncrypted | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetDestroyOnDrift` + +```csharp +private void ResetDestroyOnDrift() +``` + +##### `ResetEncryptedValue` + +```csharp +private void ResetEncryptedValue() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetKeyId` + +```csharp +private void ResetKeyId() +``` + +##### `ResetPlaintextValue` + +```csharp +private void ResetPlaintextValue() +``` + +##### `ResetValue` + +```csharp +private void ResetValue() +``` + +##### `ResetValueEncrypted` + +```csharp +private void ResetValueEncrypted() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a ActionsSecret resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsSecret.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` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsSecret.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsSecret.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsSecret.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a ActionsSecret resource upon running "cdktn 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 ActionsSecret to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing ActionsSecret that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the ActionsSecret to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| CreatedAt | string | *No description.* | +| RemoteUpdatedAt | string | *No description.* | +| RepositoryId | double | *No description.* | +| UpdatedAt | string | *No description.* | +| DestroyOnDriftInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| EncryptedValueInput | string | *No description.* | +| IdInput | string | *No description.* | +| KeyIdInput | string | *No description.* | +| PlaintextValueInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| SecretNameInput | string | *No description.* | +| ValueEncryptedInput | string | *No description.* | +| ValueInput | string | *No description.* | +| DestroyOnDrift | bool\|Io.Cdktn.IResolvable | *No description.* | +| EncryptedValue | string | *No description.* | +| Id | string | *No description.* | +| KeyId | string | *No description.* | +| PlaintextValue | string | *No description.* | +| Repository | string | *No description.* | +| SecretName | string | *No description.* | +| Value | string | *No description.* | +| ValueEncrypted | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `RemoteUpdatedAt`Required + +```csharp +public string RemoteUpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryId`Required + +```csharp +public double RepositoryId { get; } +``` + +- *Type:* double + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `DestroyOnDriftInput`Optional + +```csharp +public bool|IResolvable DestroyOnDriftInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `EncryptedValueInput`Optional + +```csharp +public string EncryptedValueInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `KeyIdInput`Optional + +```csharp +public string KeyIdInput { get; } +``` + +- *Type:* string + +--- + +##### `PlaintextValueInput`Optional + +```csharp +public string PlaintextValueInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `SecretNameInput`Optional + +```csharp +public string SecretNameInput { get; } +``` + +- *Type:* string + +--- + +##### `ValueEncryptedInput`Optional + +```csharp +public string ValueEncryptedInput { get; } +``` + +- *Type:* string + +--- + +##### `ValueInput`Optional + +```csharp +public string ValueInput { get; } +``` + +- *Type:* string + +--- + +##### `DestroyOnDrift`Required + +```csharp +public bool|IResolvable DestroyOnDrift { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `EncryptedValue`Required + +```csharp +public string EncryptedValue { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `KeyId`Required + +```csharp +public string KeyId { get; } +``` + +- *Type:* string + +--- + +##### `PlaintextValue`Required + +```csharp +public string PlaintextValue { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; } +``` + +- *Type:* string + +--- + +##### `Value`Required + +```csharp +public string Value { get; } +``` + +- *Type:* string + +--- + +##### `ValueEncrypted`Required + +```csharp +public string ValueEncrypted { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### ActionsSecretConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsSecretConfig { + 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 Repository, + string SecretName, + bool|IResolvable DestroyOnDrift = null, + string EncryptedValue = null, + string Id = null, + string KeyId = null, + string PlaintextValue = null, + string Value = null, + string ValueEncrypted = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | Name of the repository. | +| SecretName | string | Name of the secret. | +| DestroyOnDrift | bool\|Io.Cdktn.IResolvable | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#destroy_on_drift ActionsSecret#destroy_on_drift}. | +| EncryptedValue | string | Encrypted value of the secret using the GitHub public key in Base64 format. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#id ActionsSecret#id}. | +| KeyId | string | ID of the public key used to encrypt the secret. | +| PlaintextValue | string | Plaintext value of the secret to be encrypted. | +| Value | string | Plaintext value to be encrypted. | +| ValueEncrypted | string | Value encrypted with the GitHub public key, defined by key_id, in Base64 format. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#repository ActionsSecret#repository} + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; set; } +``` + +- *Type:* string + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#secret_name ActionsSecret#secret_name} + +--- + +##### `DestroyOnDrift`Optional + +```csharp +public bool|IResolvable DestroyOnDrift { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#destroy_on_drift ActionsSecret#destroy_on_drift}. + +--- + +##### `EncryptedValue`Optional + +```csharp +public string EncryptedValue { get; set; } +``` + +- *Type:* string + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#encrypted_value ActionsSecret#encrypted_value} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#id ActionsSecret#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. + +--- + +##### `KeyId`Optional + +```csharp +public string KeyId { get; set; } +``` + +- *Type:* string + +ID of the public key used to encrypt the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#key_id ActionsSecret#key_id} + +--- + +##### `PlaintextValue`Optional + +```csharp +public string PlaintextValue { get; set; } +``` + +- *Type:* string + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#plaintext_value ActionsSecret#plaintext_value} + +--- + +##### `Value`Optional + +```csharp +public string Value { get; set; } +``` + +- *Type:* string + +Plaintext value to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#value ActionsSecret#value} + +--- + +##### `ValueEncrypted`Optional + +```csharp +public string ValueEncrypted { get; set; } +``` + +- *Type:* string + +Value encrypted with the GitHub public key, defined by key_id, in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#value_encrypted ActionsSecret#value_encrypted} + +--- + + + diff --git a/docs/actionsSecret.java.md b/docs/actionsSecret.java.md new file mode 100644 index 000000000..8db3e899f --- /dev/null +++ b/docs/actionsSecret.java.md @@ -0,0 +1,1383 @@ +# `actionsSecret` Submodule + +## Constructs + +### ActionsSecret + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret github_actions_secret}. + +#### Initializers + +```java +import io.cdktn.providers.github.actions_secret.ActionsSecret; + +ActionsSecret.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) + .secretName(java.lang.String) +// .destroyOnDrift(java.lang.Boolean|IResolvable) +// .encryptedValue(java.lang.String) +// .id(java.lang.String) +// .keyId(java.lang.String) +// .plaintextValue(java.lang.String) +// .value(java.lang.String) +// .valueEncrypted(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 | *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 | *No description.* | +| repository | java.lang.String | Name of the repository. | +| secretName | java.lang.String | Name of the secret. | +| destroyOnDrift | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#destroy_on_drift ActionsSecret#destroy_on_drift}. | +| encryptedValue | java.lang.String | Encrypted value of the secret using the GitHub public key in Base64 format. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#id ActionsSecret#id}. | +| keyId | java.lang.String | ID of the public key used to encrypt the secret. | +| plaintextValue | java.lang.String | Plaintext value of the secret to be encrypted. | +| value | java.lang.String | Plaintext value to be encrypted. | +| valueEncrypted | java.lang.String | Value encrypted with the GitHub public key, defined by key_id, in Base64 format. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#repository ActionsSecret#repository} + +--- + +##### `secretName`Required + +- *Type:* java.lang.String + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#secret_name ActionsSecret#secret_name} + +--- + +##### `destroyOnDrift`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/resources/actions_secret#destroy_on_drift ActionsSecret#destroy_on_drift}. + +--- + +##### `encryptedValue`Optional + +- *Type:* java.lang.String + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#encrypted_value ActionsSecret#encrypted_value} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#id ActionsSecret#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. + +--- + +##### `keyId`Optional + +- *Type:* java.lang.String + +ID of the public key used to encrypt the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#key_id ActionsSecret#key_id} + +--- + +##### `plaintextValue`Optional + +- *Type:* java.lang.String + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#plaintext_value ActionsSecret#plaintext_value} + +--- + +##### `value`Optional + +- *Type:* java.lang.String + +Plaintext value to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#value ActionsSecret#value} + +--- + +##### `valueEncrypted`Optional + +- *Type:* java.lang.String + +Value encrypted with the GitHub public key, defined by key_id, in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#value_encrypted ActionsSecret#value_encrypted} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetDestroyOnDrift | *No description.* | +| resetEncryptedValue | *No description.* | +| resetId | *No description.* | +| resetKeyId | *No description.* | +| resetPlaintextValue | *No description.* | +| resetValue | *No description.* | +| resetValueEncrypted | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetDestroyOnDrift` + +```java +public void resetDestroyOnDrift() +``` + +##### `resetEncryptedValue` + +```java +public void resetEncryptedValue() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetKeyId` + +```java +public void resetKeyId() +``` + +##### `resetPlaintextValue` + +```java +public void resetPlaintextValue() +``` + +##### `resetValue` + +```java +public void resetValue() +``` + +##### `resetValueEncrypted` + +```java +public void resetValueEncrypted() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a ActionsSecret resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.actions_secret.ActionsSecret; + +ActionsSecret.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` + +```java +import io.cdktn.providers.github.actions_secret.ActionsSecret; + +ActionsSecret.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.actions_secret.ActionsSecret; + +ActionsSecret.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.actions_secret.ActionsSecret; + +ActionsSecret.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ActionsSecret.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a ActionsSecret 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 ActionsSecret to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing ActionsSecret that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#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 ActionsSecret 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| createdAt | java.lang.String | *No description.* | +| remoteUpdatedAt | java.lang.String | *No description.* | +| repositoryId | java.lang.Number | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| destroyOnDriftInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| encryptedValueInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| keyIdInput | java.lang.String | *No description.* | +| plaintextValueInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| secretNameInput | java.lang.String | *No description.* | +| valueEncryptedInput | java.lang.String | *No description.* | +| valueInput | java.lang.String | *No description.* | +| destroyOnDrift | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| encryptedValue | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| keyId | java.lang.String | *No description.* | +| plaintextValue | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | +| secretName | java.lang.String | *No description.* | +| value | java.lang.String | *No description.* | +| valueEncrypted | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `remoteUpdatedAt`Required + +```java +public java.lang.String getRemoteUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryId`Required + +```java +public java.lang.Number getRepositoryId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `destroyOnDriftInput`Optional + +```java +public java.lang.Boolean|IResolvable getDestroyOnDriftInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `encryptedValueInput`Optional + +```java +public java.lang.String getEncryptedValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `keyIdInput`Optional + +```java +public java.lang.String getKeyIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `plaintextValueInput`Optional + +```java +public java.lang.String getPlaintextValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretNameInput`Optional + +```java +public java.lang.String getSecretNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `valueEncryptedInput`Optional + +```java +public java.lang.String getValueEncryptedInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `valueInput`Optional + +```java +public java.lang.String getValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `destroyOnDrift`Required + +```java +public java.lang.Boolean|IResolvable getDestroyOnDrift(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `encryptedValue`Required + +```java +public java.lang.String getEncryptedValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `keyId`Required + +```java +public java.lang.String getKeyId(); +``` + +- *Type:* java.lang.String + +--- + +##### `plaintextValue`Required + +```java +public java.lang.String getPlaintextValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +--- + +##### `value`Required + +```java +public java.lang.String getValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `valueEncrypted`Required + +```java +public java.lang.String getValueEncrypted(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### ActionsSecretConfig + +#### Initializer + +```java +import io.cdktn.providers.github.actions_secret.ActionsSecretConfig; + +ActionsSecretConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) + .secretName(java.lang.String) +// .destroyOnDrift(java.lang.Boolean|IResolvable) +// .encryptedValue(java.lang.String) +// .id(java.lang.String) +// .keyId(java.lang.String) +// .plaintextValue(java.lang.String) +// .value(java.lang.String) +// .valueEncrypted(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 | *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 | *No description.* | +| repository | java.lang.String | Name of the repository. | +| secretName | java.lang.String | Name of the secret. | +| destroyOnDrift | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#destroy_on_drift ActionsSecret#destroy_on_drift}. | +| encryptedValue | java.lang.String | Encrypted value of the secret using the GitHub public key in Base64 format. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#id ActionsSecret#id}. | +| keyId | java.lang.String | ID of the public key used to encrypt the secret. | +| plaintextValue | java.lang.String | Plaintext value of the secret to be encrypted. | +| value | java.lang.String | Plaintext value to be encrypted. | +| valueEncrypted | java.lang.String | Value encrypted with the GitHub public key, defined by key_id, in Base64 format. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#repository ActionsSecret#repository} + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#secret_name ActionsSecret#secret_name} + +--- + +##### `destroyOnDrift`Optional + +```java +public java.lang.Boolean|IResolvable getDestroyOnDrift(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#destroy_on_drift ActionsSecret#destroy_on_drift}. + +--- + +##### `encryptedValue`Optional + +```java +public java.lang.String getEncryptedValue(); +``` + +- *Type:* java.lang.String + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#encrypted_value ActionsSecret#encrypted_value} + +--- + +##### `id`Optional + +```java +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/resources/actions_secret#id ActionsSecret#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. + +--- + +##### `keyId`Optional + +```java +public java.lang.String getKeyId(); +``` + +- *Type:* java.lang.String + +ID of the public key used to encrypt the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#key_id ActionsSecret#key_id} + +--- + +##### `plaintextValue`Optional + +```java +public java.lang.String getPlaintextValue(); +``` + +- *Type:* java.lang.String + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#plaintext_value ActionsSecret#plaintext_value} + +--- + +##### `value`Optional + +```java +public java.lang.String getValue(); +``` + +- *Type:* java.lang.String + +Plaintext value to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#value ActionsSecret#value} + +--- + +##### `valueEncrypted`Optional + +```java +public java.lang.String getValueEncrypted(); +``` + +- *Type:* java.lang.String + +Value encrypted with the GitHub public key, defined by key_id, in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_secret#value_encrypted ActionsSecret#value_encrypted} + +--- + + + diff --git a/docs/actionsVariable.csharp.md b/docs/actionsVariable.csharp.md new file mode 100644 index 000000000..87cb9e633 --- /dev/null +++ b/docs/actionsVariable.csharp.md @@ -0,0 +1,983 @@ +# `actionsVariable` Submodule + +## Constructs + +### ActionsVariable + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_variable github_actions_variable}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsVariable(Construct Scope, string Id, ActionsVariableConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | ActionsVariableConfig | *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:* ActionsVariableConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a ActionsVariable resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsVariable.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` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsVariable.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsVariable.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +ActionsVariable.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a ActionsVariable resource upon running "cdktn 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 ActionsVariable to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing ActionsVariable that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_variable#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the ActionsVariable to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| CreatedAt | string | *No description.* | +| RepositoryId | double | *No description.* | +| UpdatedAt | string | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| ValueInput | string | *No description.* | +| VariableNameInput | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | +| Value | string | *No description.* | +| VariableName | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryId`Required + +```csharp +public double RepositoryId { get; } +``` + +- *Type:* double + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `ValueInput`Optional + +```csharp +public string ValueInput { get; } +``` + +- *Type:* string + +--- + +##### `VariableNameInput`Optional + +```csharp +public string VariableNameInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `Value`Required + +```csharp +public string Value { get; } +``` + +- *Type:* string + +--- + +##### `VariableName`Required + +```csharp +public string VariableName { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### ActionsVariableConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ActionsVariableConfig { + 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 Repository, + string Value, + string VariableName, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | Name of the repository. | +| Value | string | Value of the variable. | +| VariableName | string | Name of the variable. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_variable#id ActionsVariable#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_variable#repository ActionsVariable#repository} + +--- + +##### `Value`Required + +```csharp +public string Value { get; set; } +``` + +- *Type:* string + +Value of the variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_variable#value ActionsVariable#value} + +--- + +##### `VariableName`Required + +```csharp +public string VariableName { get; set; } +``` + +- *Type:* string + +Name of the variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_variable#variable_name ActionsVariable#variable_name} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_variable#id ActionsVariable#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. + +--- + + + diff --git a/docs/actionsVariable.java.md b/docs/actionsVariable.java.md new file mode 100644 index 000000000..e88a7aa55 --- /dev/null +++ b/docs/actionsVariable.java.md @@ -0,0 +1,1084 @@ +# `actionsVariable` Submodule + +## Constructs + +### ActionsVariable + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_variable github_actions_variable}. + +#### Initializers + +```java +import io.cdktn.providers.github.actions_variable.ActionsVariable; + +ActionsVariable.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) + .value(java.lang.String) + .variableName(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Name of the repository. | +| value | java.lang.String | Value of the variable. | +| variableName | java.lang.String | Name of the variable. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_variable#id ActionsVariable#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_variable#repository ActionsVariable#repository} + +--- + +##### `value`Required + +- *Type:* java.lang.String + +Value of the variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_variable#value ActionsVariable#value} + +--- + +##### `variableName`Required + +- *Type:* java.lang.String + +Name of the variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_variable#variable_name ActionsVariable#variable_name} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_variable#id ActionsVariable#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a ActionsVariable resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.actions_variable.ActionsVariable; + +ActionsVariable.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` + +```java +import io.cdktn.providers.github.actions_variable.ActionsVariable; + +ActionsVariable.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.actions_variable.ActionsVariable; + +ActionsVariable.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.actions_variable.ActionsVariable; + +ActionsVariable.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ActionsVariable.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a ActionsVariable 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 ActionsVariable to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing ActionsVariable that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_variable#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 ActionsVariable 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| createdAt | java.lang.String | *No description.* | +| repositoryId | java.lang.Number | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| valueInput | java.lang.String | *No description.* | +| variableNameInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | +| value | java.lang.String | *No description.* | +| variableName | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryId`Required + +```java +public java.lang.Number getRepositoryId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `valueInput`Optional + +```java +public java.lang.String getValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `variableNameInput`Optional + +```java +public java.lang.String getVariableNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `value`Required + +```java +public java.lang.String getValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `variableName`Required + +```java +public java.lang.String getVariableName(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### ActionsVariableConfig + +#### Initializer + +```java +import io.cdktn.providers.github.actions_variable.ActionsVariableConfig; + +ActionsVariableConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) + .value(java.lang.String) + .variableName(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Name of the repository. | +| value | java.lang.String | Value of the variable. | +| variableName | java.lang.String | Name of the variable. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_variable#id ActionsVariable#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_variable#repository ActionsVariable#repository} + +--- + +##### `value`Required + +```java +public java.lang.String getValue(); +``` + +- *Type:* java.lang.String + +Value of the variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_variable#value ActionsVariable#value} + +--- + +##### `variableName`Required + +```java +public java.lang.String getVariableName(); +``` + +- *Type:* java.lang.String + +Name of the variable. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/actions_variable#variable_name ActionsVariable#variable_name} + +--- + +##### `id`Optional + +```java +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/resources/actions_variable#id ActionsVariable#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. + +--- + + + diff --git a/docs/appInstallationRepositories.csharp.md b/docs/appInstallationRepositories.csharp.md new file mode 100644 index 000000000..802fd803b --- /dev/null +++ b/docs/appInstallationRepositories.csharp.md @@ -0,0 +1,912 @@ +# `appInstallationRepositories` Submodule + +## Constructs + +### AppInstallationRepositories + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repositories github_app_installation_repositories}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new AppInstallationRepositories(Construct Scope, string Id, AppInstallationRepositoriesConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | AppInstallationRepositoriesConfig | *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:* AppInstallationRepositoriesConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a AppInstallationRepositories resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +AppInstallationRepositories.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` + +```csharp +using Io.Cdktn.Providers.Github; + +AppInstallationRepositories.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +AppInstallationRepositories.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +AppInstallationRepositories.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a AppInstallationRepositories resource upon running "cdktn 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 AppInstallationRepositories to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing AppInstallationRepositories that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repositories#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the AppInstallationRepositories to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| IdInput | string | *No description.* | +| InstallationIdInput | string | *No description.* | +| SelectedRepositoriesInput | string[] | *No description.* | +| Id | string | *No description.* | +| InstallationId | string | *No description.* | +| SelectedRepositories | string[] | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `InstallationIdInput`Optional + +```csharp +public string InstallationIdInput { get; } +``` + +- *Type:* string + +--- + +##### `SelectedRepositoriesInput`Optional + +```csharp +public string[] SelectedRepositoriesInput { get; } +``` + +- *Type:* string[] + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `InstallationId`Required + +```csharp +public string InstallationId { get; } +``` + +- *Type:* string + +--- + +##### `SelectedRepositories`Required + +```csharp +public string[] SelectedRepositories { get; } +``` + +- *Type:* string[] + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### AppInstallationRepositoriesConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new AppInstallationRepositoriesConfig { + 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 InstallationId, + string[] SelectedRepositories, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| InstallationId | string | The GitHub app installation id. | +| SelectedRepositories | string[] | A list of repository names to install the app on. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repositories#id AppInstallationRepositories#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `InstallationId`Required + +```csharp +public string InstallationId { get; set; } +``` + +- *Type:* string + +The GitHub app installation id. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repositories#installation_id AppInstallationRepositories#installation_id} + +--- + +##### `SelectedRepositories`Required + +```csharp +public string[] SelectedRepositories { get; set; } +``` + +- *Type:* string[] + +A list of repository names to install the app on. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repositories#selected_repositories AppInstallationRepositories#selected_repositories} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repositories#id AppInstallationRepositories#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. + +--- + + + diff --git a/docs/appInstallationRepositories.java.md b/docs/appInstallationRepositories.java.md new file mode 100644 index 000000000..473f5e729 --- /dev/null +++ b/docs/appInstallationRepositories.java.md @@ -0,0 +1,1001 @@ +# `appInstallationRepositories` Submodule + +## Constructs + +### AppInstallationRepositories + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repositories github_app_installation_repositories}. + +#### Initializers + +```java +import io.cdktn.providers.github.app_installation_repositories.AppInstallationRepositories; + +AppInstallationRepositories.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .installationId(java.lang.String) + .selectedRepositories(java.util.List) +// .id(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 | *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 | *No description.* | +| installationId | java.lang.String | The GitHub app installation id. | +| selectedRepositories | java.util.List | A list of repository names to install the app on. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repositories#id AppInstallationRepositories#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `installationId`Required + +- *Type:* java.lang.String + +The GitHub app installation id. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repositories#installation_id AppInstallationRepositories#installation_id} + +--- + +##### `selectedRepositories`Required + +- *Type:* java.util.List + +A list of repository names to install the app on. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repositories#selected_repositories AppInstallationRepositories#selected_repositories} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repositories#id AppInstallationRepositories#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a AppInstallationRepositories resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.app_installation_repositories.AppInstallationRepositories; + +AppInstallationRepositories.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` + +```java +import io.cdktn.providers.github.app_installation_repositories.AppInstallationRepositories; + +AppInstallationRepositories.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.app_installation_repositories.AppInstallationRepositories; + +AppInstallationRepositories.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.app_installation_repositories.AppInstallationRepositories; + +AppInstallationRepositories.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),AppInstallationRepositories.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a AppInstallationRepositories 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 AppInstallationRepositories to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing AppInstallationRepositories that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_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 AppInstallationRepositories 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| idInput | java.lang.String | *No description.* | +| installationIdInput | java.lang.String | *No description.* | +| selectedRepositoriesInput | java.util.List | *No description.* | +| id | java.lang.String | *No description.* | +| installationId | java.lang.String | *No description.* | +| selectedRepositories | java.util.List | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `installationIdInput`Optional + +```java +public java.lang.String getInstallationIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `selectedRepositoriesInput`Optional + +```java +public java.util.List getSelectedRepositoriesInput(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `installationId`Required + +```java +public java.lang.String getInstallationId(); +``` + +- *Type:* java.lang.String + +--- + +##### `selectedRepositories`Required + +```java +public java.util.List getSelectedRepositories(); +``` + +- *Type:* java.util.List + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### AppInstallationRepositoriesConfig + +#### Initializer + +```java +import io.cdktn.providers.github.app_installation_repositories.AppInstallationRepositoriesConfig; + +AppInstallationRepositoriesConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .installationId(java.lang.String) + .selectedRepositories(java.util.List) +// .id(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 | *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 | *No description.* | +| installationId | java.lang.String | The GitHub app installation id. | +| selectedRepositories | java.util.List | A list of repository names to install the app on. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repositories#id AppInstallationRepositories#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `installationId`Required + +```java +public java.lang.String getInstallationId(); +``` + +- *Type:* java.lang.String + +The GitHub app installation id. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repositories#installation_id AppInstallationRepositories#installation_id} + +--- + +##### `selectedRepositories`Required + +```java +public java.util.List getSelectedRepositories(); +``` + +- *Type:* java.util.List + +A list of repository names to install the app on. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repositories#selected_repositories AppInstallationRepositories#selected_repositories} + +--- + +##### `id`Optional + +```java +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/resources/app_installation_repositories#id AppInstallationRepositories#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. + +--- + + + diff --git a/docs/appInstallationRepository.csharp.md b/docs/appInstallationRepository.csharp.md new file mode 100644 index 000000000..cf37f5e44 --- /dev/null +++ b/docs/appInstallationRepository.csharp.md @@ -0,0 +1,923 @@ +# `appInstallationRepository` Submodule + +## Constructs + +### AppInstallationRepository + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repository github_app_installation_repository}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new AppInstallationRepository(Construct Scope, string Id, AppInstallationRepositoryConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | AppInstallationRepositoryConfig | *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:* AppInstallationRepositoryConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a AppInstallationRepository resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +AppInstallationRepository.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` + +```csharp +using Io.Cdktn.Providers.Github; + +AppInstallationRepository.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +AppInstallationRepository.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +AppInstallationRepository.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a AppInstallationRepository resource upon running "cdktn 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 AppInstallationRepository to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing AppInstallationRepository that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repository#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the AppInstallationRepository to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| RepoId | double | *No description.* | +| IdInput | string | *No description.* | +| InstallationIdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Id | string | *No description.* | +| InstallationId | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `RepoId`Required + +```csharp +public double RepoId { get; } +``` + +- *Type:* double + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `InstallationIdInput`Optional + +```csharp +public string InstallationIdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `InstallationId`Required + +```csharp +public string InstallationId { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### AppInstallationRepositoryConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new AppInstallationRepositoryConfig { + 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 InstallationId, + string Repository, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| InstallationId | string | The GitHub app installation id. | +| Repository | string | The repository to install the app on. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repository#id AppInstallationRepository#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `InstallationId`Required + +```csharp +public string InstallationId { get; set; } +``` + +- *Type:* string + +The GitHub app installation id. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repository#installation_id AppInstallationRepository#installation_id} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The repository to install the app on. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repository#repository AppInstallationRepository#repository} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repository#id AppInstallationRepository#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. + +--- + + + diff --git a/docs/appInstallationRepository.java.md b/docs/appInstallationRepository.java.md new file mode 100644 index 000000000..ccfb8d775 --- /dev/null +++ b/docs/appInstallationRepository.java.md @@ -0,0 +1,1012 @@ +# `appInstallationRepository` Submodule + +## Constructs + +### AppInstallationRepository + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repository github_app_installation_repository}. + +#### Initializers + +```java +import io.cdktn.providers.github.app_installation_repository.AppInstallationRepository; + +AppInstallationRepository.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .installationId(java.lang.String) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| installationId | java.lang.String | The GitHub app installation id. | +| repository | java.lang.String | The repository to install the app on. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repository#id AppInstallationRepository#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `installationId`Required + +- *Type:* java.lang.String + +The GitHub app installation id. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repository#installation_id AppInstallationRepository#installation_id} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The repository to install the app on. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repository#repository AppInstallationRepository#repository} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repository#id AppInstallationRepository#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a AppInstallationRepository resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.app_installation_repository.AppInstallationRepository; + +AppInstallationRepository.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` + +```java +import io.cdktn.providers.github.app_installation_repository.AppInstallationRepository; + +AppInstallationRepository.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.app_installation_repository.AppInstallationRepository; + +AppInstallationRepository.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.app_installation_repository.AppInstallationRepository; + +AppInstallationRepository.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),AppInstallationRepository.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a AppInstallationRepository 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 AppInstallationRepository to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing AppInstallationRepository that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repository#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 AppInstallationRepository 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| repoId | java.lang.Number | *No description.* | +| idInput | java.lang.String | *No description.* | +| installationIdInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| installationId | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repoId`Required + +```java +public java.lang.Number getRepoId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `installationIdInput`Optional + +```java +public java.lang.String getInstallationIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `installationId`Required + +```java +public java.lang.String getInstallationId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### AppInstallationRepositoryConfig + +#### Initializer + +```java +import io.cdktn.providers.github.app_installation_repository.AppInstallationRepositoryConfig; + +AppInstallationRepositoryConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .installationId(java.lang.String) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| installationId | java.lang.String | The GitHub app installation id. | +| repository | java.lang.String | The repository to install the app on. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repository#id AppInstallationRepository#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `installationId`Required + +```java +public java.lang.String getInstallationId(); +``` + +- *Type:* java.lang.String + +The GitHub app installation id. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repository#installation_id AppInstallationRepository#installation_id} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The repository to install the app on. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/app_installation_repository#repository AppInstallationRepository#repository} + +--- + +##### `id`Optional + +```java +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/resources/app_installation_repository#id AppInstallationRepository#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. + +--- + + + diff --git a/docs/branch.csharp.md b/docs/branch.csharp.md new file mode 100644 index 000000000..ff18259b7 --- /dev/null +++ b/docs/branch.csharp.md @@ -0,0 +1,1069 @@ +# `branch` Submodule + +## Constructs + +### Branch + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch github_branch}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new Branch(Construct Scope, string Id, BranchConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | BranchConfig | *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:* BranchConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetEtag | *No description.* | +| ResetId | *No description.* | +| ResetSourceBranch | *No description.* | +| ResetSourceSha | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetEtag` + +```csharp +private void ResetEtag() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetSourceBranch` + +```csharp +private void ResetSourceBranch() +``` + +##### `ResetSourceSha` + +```csharp +private void ResetSourceSha() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a Branch resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +Branch.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` + +```csharp +using Io.Cdktn.Providers.Github; + +Branch.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +Branch.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +Branch.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a Branch resource upon running "cdktn 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 Branch to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing Branch that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the Branch to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Ref | string | *No description.* | +| Sha | string | *No description.* | +| BranchInput | string | *No description.* | +| EtagInput | string | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| SourceBranchInput | string | *No description.* | +| SourceShaInput | string | *No description.* | +| Branch | string | *No description.* | +| Etag | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | +| SourceBranch | string | *No description.* | +| SourceSha | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Ref`Required + +```csharp +public string Ref { get; } +``` + +- *Type:* string + +--- + +##### `Sha`Required + +```csharp +public string Sha { get; } +``` + +- *Type:* string + +--- + +##### `BranchInput`Optional + +```csharp +public string BranchInput { get; } +``` + +- *Type:* string + +--- + +##### `EtagInput`Optional + +```csharp +public string EtagInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `SourceBranchInput`Optional + +```csharp +public string SourceBranchInput { get; } +``` + +- *Type:* string + +--- + +##### `SourceShaInput`Optional + +```csharp +public string SourceShaInput { get; } +``` + +- *Type:* string + +--- + +##### `Branch`Required + +```csharp +public string Branch { get; } +``` + +- *Type:* string + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `SourceBranch`Required + +```csharp +public string SourceBranch { get; } +``` + +- *Type:* string + +--- + +##### `SourceSha`Required + +```csharp +public string SourceSha { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### BranchConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchConfig { + 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 Branch, + string Repository, + string Etag = null, + string Id = null, + string SourceBranch = null, + string SourceSha = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Branch | string | The repository branch to create. | +| Repository | string | The GitHub repository name. | +| Etag | string | An etag representing the Branch object. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch#id Branch#id}. | +| SourceBranch | string | The branch name to start from. Defaults to 'main'. | +| SourceSha | string | The commit hash to start from. Defaults to the tip of 'source_branch'. If provided, 'source_branch' is ignored. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Branch`Required + +```csharp +public string Branch { get; set; } +``` + +- *Type:* string + +The repository branch to create. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch#branch Branch#branch} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The GitHub repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch#repository Branch#repository} + +--- + +##### `Etag`Optional + +```csharp +public string Etag { get; set; } +``` + +- *Type:* string + +An etag representing the Branch object. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch#etag Branch#etag} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch#id Branch#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. + +--- + +##### `SourceBranch`Optional + +```csharp +public string SourceBranch { get; set; } +``` + +- *Type:* string + +The branch name to start from. Defaults to 'main'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch#source_branch Branch#source_branch} + +--- + +##### `SourceSha`Optional + +```csharp +public string SourceSha { get; set; } +``` + +- *Type:* string + +The commit hash to start from. Defaults to the tip of 'source_branch'. If provided, 'source_branch' is ignored. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch#source_sha Branch#source_sha} + +--- + + + diff --git a/docs/branch.java.md b/docs/branch.java.md new file mode 100644 index 000000000..ebf154ffb --- /dev/null +++ b/docs/branch.java.md @@ -0,0 +1,1194 @@ +# `branch` Submodule + +## Constructs + +### Branch + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch github_branch}. + +#### Initializers + +```java +import io.cdktn.providers.github.branch.Branch; + +Branch.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .branch(java.lang.String) + .repository(java.lang.String) +// .etag(java.lang.String) +// .id(java.lang.String) +// .sourceBranch(java.lang.String) +// .sourceSha(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 | *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 | *No description.* | +| branch | java.lang.String | The repository branch to create. | +| repository | java.lang.String | The GitHub repository name. | +| etag | java.lang.String | An etag representing the Branch object. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch#id Branch#id}. | +| sourceBranch | java.lang.String | The branch name to start from. Defaults to 'main'. | +| sourceSha | java.lang.String | The commit hash to start from. Defaults to the tip of 'source_branch'. If provided, 'source_branch' is ignored. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `branch`Required + +- *Type:* java.lang.String + +The repository branch to create. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch#branch Branch#branch} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The GitHub repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch#repository Branch#repository} + +--- + +##### `etag`Optional + +- *Type:* java.lang.String + +An etag representing the Branch object. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch#etag Branch#etag} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch#id Branch#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. + +--- + +##### `sourceBranch`Optional + +- *Type:* java.lang.String + +The branch name to start from. Defaults to 'main'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch#source_branch Branch#source_branch} + +--- + +##### `sourceSha`Optional + +- *Type:* java.lang.String + +The commit hash to start from. Defaults to the tip of 'source_branch'. If provided, 'source_branch' is ignored. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch#source_sha Branch#source_sha} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetEtag | *No description.* | +| resetId | *No description.* | +| resetSourceBranch | *No description.* | +| resetSourceSha | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetEtag` + +```java +public void resetEtag() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetSourceBranch` + +```java +public void resetSourceBranch() +``` + +##### `resetSourceSha` + +```java +public void resetSourceSha() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a Branch resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.branch.Branch; + +Branch.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` + +```java +import io.cdktn.providers.github.branch.Branch; + +Branch.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.branch.Branch; + +Branch.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.branch.Branch; + +Branch.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),Branch.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a Branch 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 Branch to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing Branch that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch#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 Branch 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| ref | java.lang.String | *No description.* | +| sha | java.lang.String | *No description.* | +| branchInput | java.lang.String | *No description.* | +| etagInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| sourceBranchInput | java.lang.String | *No description.* | +| sourceShaInput | java.lang.String | *No description.* | +| branch | java.lang.String | *No description.* | +| etag | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | +| sourceBranch | java.lang.String | *No description.* | +| sourceSha | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `ref`Required + +```java +public java.lang.String getRef(); +``` + +- *Type:* java.lang.String + +--- + +##### `sha`Required + +```java +public java.lang.String getSha(); +``` + +- *Type:* java.lang.String + +--- + +##### `branchInput`Optional + +```java +public java.lang.String getBranchInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `etagInput`Optional + +```java +public java.lang.String getEtagInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `sourceBranchInput`Optional + +```java +public java.lang.String getSourceBranchInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `sourceShaInput`Optional + +```java +public java.lang.String getSourceShaInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `branch`Required + +```java +public java.lang.String getBranch(); +``` + +- *Type:* java.lang.String + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `sourceBranch`Required + +```java +public java.lang.String getSourceBranch(); +``` + +- *Type:* java.lang.String + +--- + +##### `sourceSha`Required + +```java +public java.lang.String getSourceSha(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### BranchConfig + +#### Initializer + +```java +import io.cdktn.providers.github.branch.BranchConfig; + +BranchConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .branch(java.lang.String) + .repository(java.lang.String) +// .etag(java.lang.String) +// .id(java.lang.String) +// .sourceBranch(java.lang.String) +// .sourceSha(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 | *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 | *No description.* | +| branch | java.lang.String | The repository branch to create. | +| repository | java.lang.String | The GitHub repository name. | +| etag | java.lang.String | An etag representing the Branch object. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch#id Branch#id}. | +| sourceBranch | java.lang.String | The branch name to start from. Defaults to 'main'. | +| sourceSha | java.lang.String | The commit hash to start from. Defaults to the tip of 'source_branch'. If provided, 'source_branch' is ignored. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `branch`Required + +```java +public java.lang.String getBranch(); +``` + +- *Type:* java.lang.String + +The repository branch to create. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch#branch Branch#branch} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The GitHub repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch#repository Branch#repository} + +--- + +##### `etag`Optional + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +An etag representing the Branch object. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch#etag Branch#etag} + +--- + +##### `id`Optional + +```java +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/resources/branch#id Branch#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. + +--- + +##### `sourceBranch`Optional + +```java +public java.lang.String getSourceBranch(); +``` + +- *Type:* java.lang.String + +The branch name to start from. Defaults to 'main'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch#source_branch Branch#source_branch} + +--- + +##### `sourceSha`Optional + +```java +public java.lang.String getSourceSha(); +``` + +- *Type:* java.lang.String + +The commit hash to start from. Defaults to the tip of 'source_branch'. If provided, 'source_branch' is ignored. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch#source_sha Branch#source_sha} + +--- + + + diff --git a/docs/branchDefault.csharp.md b/docs/branchDefault.csharp.md new file mode 100644 index 000000000..b23da6522 --- /dev/null +++ b/docs/branchDefault.csharp.md @@ -0,0 +1,1000 @@ +# `branchDefault` Submodule + +## Constructs + +### BranchDefault + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default github_branch_default}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchDefault(Construct Scope, string Id, BranchDefaultConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | BranchDefaultConfig | *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:* BranchDefaultConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetEtag | *No description.* | +| ResetId | *No description.* | +| ResetRename | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetEtag` + +```csharp +private void ResetEtag() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetRename` + +```csharp +private void ResetRename() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a BranchDefault resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +BranchDefault.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` + +```csharp +using Io.Cdktn.Providers.Github; + +BranchDefault.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +BranchDefault.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +BranchDefault.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a BranchDefault resource upon running "cdktn 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 BranchDefault to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing BranchDefault that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the BranchDefault to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| BranchInput | string | *No description.* | +| EtagInput | string | *No description.* | +| IdInput | string | *No description.* | +| RenameInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RepositoryInput | string | *No description.* | +| Branch | string | *No description.* | +| Etag | string | *No description.* | +| Id | string | *No description.* | +| Rename | bool\|Io.Cdktn.IResolvable | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `BranchInput`Optional + +```csharp +public string BranchInput { get; } +``` + +- *Type:* string + +--- + +##### `EtagInput`Optional + +```csharp +public string EtagInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RenameInput`Optional + +```csharp +public bool|IResolvable RenameInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Branch`Required + +```csharp +public string Branch { get; } +``` + +- *Type:* string + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Rename`Required + +```csharp +public bool|IResolvable Rename { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### BranchDefaultConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchDefaultConfig { + 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 Branch, + string Repository, + string Etag = null, + string Id = null, + bool|IResolvable Rename = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Branch | string | The branch (e.g. 'main'). | +| Repository | string | The GitHub repository. | +| Etag | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default#etag BranchDefault#etag}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default#id BranchDefault#id}. | +| Rename | bool\|Io.Cdktn.IResolvable | Indicate if it should rename the branch rather than use an existing branch. Defaults to 'false'. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Branch`Required + +```csharp +public string Branch { get; set; } +``` + +- *Type:* string + +The branch (e.g. 'main'). + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default#branch BranchDefault#branch} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default#repository BranchDefault#repository} + +--- + +##### `Etag`Optional + +```csharp +public string Etag { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default#etag BranchDefault#etag}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default#id BranchDefault#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. + +--- + +##### `Rename`Optional + +```csharp +public bool|IResolvable Rename { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Indicate if it should rename the branch rather than use an existing branch. Defaults to 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default#rename BranchDefault#rename} + +--- + + + diff --git a/docs/branchDefault.java.md b/docs/branchDefault.java.md new file mode 100644 index 000000000..e4d901ac8 --- /dev/null +++ b/docs/branchDefault.java.md @@ -0,0 +1,1111 @@ +# `branchDefault` Submodule + +## Constructs + +### BranchDefault + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default github_branch_default}. + +#### Initializers + +```java +import io.cdktn.providers.github.branch_default.BranchDefault; + +BranchDefault.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .branch(java.lang.String) + .repository(java.lang.String) +// .etag(java.lang.String) +// .id(java.lang.String) +// .rename(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 | *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 | *No description.* | +| branch | java.lang.String | The branch (e.g. 'main'). | +| repository | java.lang.String | The GitHub repository. | +| etag | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default#etag BranchDefault#etag}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default#id BranchDefault#id}. | +| rename | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Indicate if it should rename the branch rather than use an existing branch. Defaults to 'false'. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `branch`Required + +- *Type:* java.lang.String + +The branch (e.g. 'main'). + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default#branch BranchDefault#branch} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default#repository BranchDefault#repository} + +--- + +##### `etag`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default#etag BranchDefault#etag}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default#id BranchDefault#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. + +--- + +##### `rename`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Indicate if it should rename the branch rather than use an existing branch. Defaults to 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default#rename BranchDefault#rename} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetEtag | *No description.* | +| resetId | *No description.* | +| resetRename | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetEtag` + +```java +public void resetEtag() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetRename` + +```java +public void resetRename() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a BranchDefault resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.branch_default.BranchDefault; + +BranchDefault.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` + +```java +import io.cdktn.providers.github.branch_default.BranchDefault; + +BranchDefault.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.branch_default.BranchDefault; + +BranchDefault.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.branch_default.BranchDefault; + +BranchDefault.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),BranchDefault.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a BranchDefault 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 BranchDefault to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing BranchDefault that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default#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 BranchDefault 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| branchInput | java.lang.String | *No description.* | +| etagInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| renameInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| branch | java.lang.String | *No description.* | +| etag | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| rename | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `branchInput`Optional + +```java +public java.lang.String getBranchInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `etagInput`Optional + +```java +public java.lang.String getEtagInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `renameInput`Optional + +```java +public java.lang.Boolean|IResolvable getRenameInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `branch`Required + +```java +public java.lang.String getBranch(); +``` + +- *Type:* java.lang.String + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `rename`Required + +```java +public java.lang.Boolean|IResolvable getRename(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### BranchDefaultConfig + +#### Initializer + +```java +import io.cdktn.providers.github.branch_default.BranchDefaultConfig; + +BranchDefaultConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .branch(java.lang.String) + .repository(java.lang.String) +// .etag(java.lang.String) +// .id(java.lang.String) +// .rename(java.lang.Boolean|IResolvable) + .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 | *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 | *No description.* | +| branch | java.lang.String | The branch (e.g. 'main'). | +| repository | java.lang.String | The GitHub repository. | +| etag | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default#etag BranchDefault#etag}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default#id BranchDefault#id}. | +| rename | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Indicate if it should rename the branch rather than use an existing branch. Defaults to 'false'. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `branch`Required + +```java +public java.lang.String getBranch(); +``` + +- *Type:* java.lang.String + +The branch (e.g. 'main'). + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default#branch BranchDefault#branch} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default#repository BranchDefault#repository} + +--- + +##### `etag`Optional + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default#etag BranchDefault#etag}. + +--- + +##### `id`Optional + +```java +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/resources/branch_default#id BranchDefault#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. + +--- + +##### `rename`Optional + +```java +public java.lang.Boolean|IResolvable getRename(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Indicate if it should rename the branch rather than use an existing branch. Defaults to 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_default#rename BranchDefault#rename} + +--- + + + diff --git a/docs/branchProtection.csharp.md b/docs/branchProtection.csharp.md new file mode 100644 index 000000000..f6d29d436 --- /dev/null +++ b/docs/branchProtection.csharp.md @@ -0,0 +1,3289 @@ +# `branchProtection` Submodule + +## Constructs + +### BranchProtection + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection github_branch_protection}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchProtection(Construct Scope, string Id, BranchProtectionConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | BranchProtectionConfig | *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:* BranchProtectionConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| PutRequiredPullRequestReviews | *No description.* | +| PutRequiredStatusChecks | *No description.* | +| PutRestrictPushes | *No description.* | +| ResetAllowsDeletions | *No description.* | +| ResetAllowsForcePushes | *No description.* | +| ResetEnforceAdmins | *No description.* | +| ResetForcePushBypassers | *No description.* | +| ResetId | *No description.* | +| ResetLockBranch | *No description.* | +| ResetRequireConversationResolution | *No description.* | +| ResetRequiredLinearHistory | *No description.* | +| ResetRequiredPullRequestReviews | *No description.* | +| ResetRequiredStatusChecks | *No description.* | +| ResetRequireSignedCommits | *No description.* | +| ResetRestrictPushes | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `PutRequiredPullRequestReviews` + +```csharp +private void PutRequiredPullRequestReviews(IResolvable|BranchProtectionRequiredPullRequestReviews[] Value) +``` + +###### `Value`Required + +- *Type:* Io.Cdktn.IResolvable|BranchProtectionRequiredPullRequestReviews[] + +--- + +##### `PutRequiredStatusChecks` + +```csharp +private void PutRequiredStatusChecks(IResolvable|BranchProtectionRequiredStatusChecks[] Value) +``` + +###### `Value`Required + +- *Type:* Io.Cdktn.IResolvable|BranchProtectionRequiredStatusChecks[] + +--- + +##### `PutRestrictPushes` + +```csharp +private void PutRestrictPushes(IResolvable|BranchProtectionRestrictPushes[] Value) +``` + +###### `Value`Required + +- *Type:* Io.Cdktn.IResolvable|BranchProtectionRestrictPushes[] + +--- + +##### `ResetAllowsDeletions` + +```csharp +private void ResetAllowsDeletions() +``` + +##### `ResetAllowsForcePushes` + +```csharp +private void ResetAllowsForcePushes() +``` + +##### `ResetEnforceAdmins` + +```csharp +private void ResetEnforceAdmins() +``` + +##### `ResetForcePushBypassers` + +```csharp +private void ResetForcePushBypassers() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetLockBranch` + +```csharp +private void ResetLockBranch() +``` + +##### `ResetRequireConversationResolution` + +```csharp +private void ResetRequireConversationResolution() +``` + +##### `ResetRequiredLinearHistory` + +```csharp +private void ResetRequiredLinearHistory() +``` + +##### `ResetRequiredPullRequestReviews` + +```csharp +private void ResetRequiredPullRequestReviews() +``` + +##### `ResetRequiredStatusChecks` + +```csharp +private void ResetRequiredStatusChecks() +``` + +##### `ResetRequireSignedCommits` + +```csharp +private void ResetRequireSignedCommits() +``` + +##### `ResetRestrictPushes` + +```csharp +private void ResetRestrictPushes() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a BranchProtection resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +BranchProtection.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` + +```csharp +using Io.Cdktn.Providers.Github; + +BranchProtection.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +BranchProtection.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +BranchProtection.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a BranchProtection resource upon running "cdktn 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 BranchProtection to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing BranchProtection that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the BranchProtection to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| RequiredPullRequestReviews | BranchProtectionRequiredPullRequestReviewsList | *No description.* | +| RequiredStatusChecks | BranchProtectionRequiredStatusChecksList | *No description.* | +| RestrictPushes | BranchProtectionRestrictPushesList | *No description.* | +| AllowsDeletionsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| AllowsForcePushesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| EnforceAdminsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| ForcePushBypassersInput | string[] | *No description.* | +| IdInput | string | *No description.* | +| LockBranchInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| PatternInput | string | *No description.* | +| RepositoryIdInput | string | *No description.* | +| RequireConversationResolutionInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequiredLinearHistoryInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequiredPullRequestReviewsInput | Io.Cdktn.IResolvable\|BranchProtectionRequiredPullRequestReviews[] | *No description.* | +| RequiredStatusChecksInput | Io.Cdktn.IResolvable\|BranchProtectionRequiredStatusChecks[] | *No description.* | +| RequireSignedCommitsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RestrictPushesInput | Io.Cdktn.IResolvable\|BranchProtectionRestrictPushes[] | *No description.* | +| AllowsDeletions | bool\|Io.Cdktn.IResolvable | *No description.* | +| AllowsForcePushes | bool\|Io.Cdktn.IResolvable | *No description.* | +| EnforceAdmins | bool\|Io.Cdktn.IResolvable | *No description.* | +| ForcePushBypassers | string[] | *No description.* | +| Id | string | *No description.* | +| LockBranch | bool\|Io.Cdktn.IResolvable | *No description.* | +| Pattern | string | *No description.* | +| RepositoryId | string | *No description.* | +| RequireConversationResolution | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequiredLinearHistory | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequireSignedCommits | bool\|Io.Cdktn.IResolvable | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `RequiredPullRequestReviews`Required + +```csharp +public BranchProtectionRequiredPullRequestReviewsList RequiredPullRequestReviews { get; } +``` + +- *Type:* BranchProtectionRequiredPullRequestReviewsList + +--- + +##### `RequiredStatusChecks`Required + +```csharp +public BranchProtectionRequiredStatusChecksList RequiredStatusChecks { get; } +``` + +- *Type:* BranchProtectionRequiredStatusChecksList + +--- + +##### `RestrictPushes`Required + +```csharp +public BranchProtectionRestrictPushesList RestrictPushes { get; } +``` + +- *Type:* BranchProtectionRestrictPushesList + +--- + +##### `AllowsDeletionsInput`Optional + +```csharp +public bool|IResolvable AllowsDeletionsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `AllowsForcePushesInput`Optional + +```csharp +public bool|IResolvable AllowsForcePushesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `EnforceAdminsInput`Optional + +```csharp +public bool|IResolvable EnforceAdminsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ForcePushBypassersInput`Optional + +```csharp +public string[] ForcePushBypassersInput { get; } +``` + +- *Type:* string[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `LockBranchInput`Optional + +```csharp +public bool|IResolvable LockBranchInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `PatternInput`Optional + +```csharp +public string PatternInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryIdInput`Optional + +```csharp +public string RepositoryIdInput { get; } +``` + +- *Type:* string + +--- + +##### `RequireConversationResolutionInput`Optional + +```csharp +public bool|IResolvable RequireConversationResolutionInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequiredLinearHistoryInput`Optional + +```csharp +public bool|IResolvable RequiredLinearHistoryInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequiredPullRequestReviewsInput`Optional + +```csharp +public IResolvable|BranchProtectionRequiredPullRequestReviews[] RequiredPullRequestReviewsInput { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|BranchProtectionRequiredPullRequestReviews[] + +--- + +##### `RequiredStatusChecksInput`Optional + +```csharp +public IResolvable|BranchProtectionRequiredStatusChecks[] RequiredStatusChecksInput { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|BranchProtectionRequiredStatusChecks[] + +--- + +##### `RequireSignedCommitsInput`Optional + +```csharp +public bool|IResolvable RequireSignedCommitsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RestrictPushesInput`Optional + +```csharp +public IResolvable|BranchProtectionRestrictPushes[] RestrictPushesInput { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|BranchProtectionRestrictPushes[] + +--- + +##### `AllowsDeletions`Required + +```csharp +public bool|IResolvable AllowsDeletions { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `AllowsForcePushes`Required + +```csharp +public bool|IResolvable AllowsForcePushes { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `EnforceAdmins`Required + +```csharp +public bool|IResolvable EnforceAdmins { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ForcePushBypassers`Required + +```csharp +public string[] ForcePushBypassers { get; } +``` + +- *Type:* string[] + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `LockBranch`Required + +```csharp +public bool|IResolvable LockBranch { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryId`Required + +```csharp +public string RepositoryId { get; } +``` + +- *Type:* string + +--- + +##### `RequireConversationResolution`Required + +```csharp +public bool|IResolvable RequireConversationResolution { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequiredLinearHistory`Required + +```csharp +public bool|IResolvable RequiredLinearHistory { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequireSignedCommits`Required + +```csharp +public bool|IResolvable RequireSignedCommits { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### BranchProtectionConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchProtectionConfig { + 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 Pattern, + string RepositoryId, + bool|IResolvable AllowsDeletions = null, + bool|IResolvable AllowsForcePushes = null, + bool|IResolvable EnforceAdmins = null, + string[] ForcePushBypassers = null, + string Id = null, + bool|IResolvable LockBranch = null, + bool|IResolvable RequireConversationResolution = null, + bool|IResolvable RequiredLinearHistory = null, + IResolvable|BranchProtectionRequiredPullRequestReviews[] RequiredPullRequestReviews = null, + IResolvable|BranchProtectionRequiredStatusChecks[] RequiredStatusChecks = null, + bool|IResolvable RequireSignedCommits = null, + IResolvable|BranchProtectionRestrictPushes[] RestrictPushes = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Pattern | string | Identifies the protection rule pattern. | +| RepositoryId | string | The name or node ID of the repository associated with this branch protection rule. | +| AllowsDeletions | bool\|Io.Cdktn.IResolvable | Setting this to 'true' to allow the branch to be deleted. | +| AllowsForcePushes | bool\|Io.Cdktn.IResolvable | Setting this to 'true' to allow force pushes on the branch. | +| EnforceAdmins | bool\|Io.Cdktn.IResolvable | Setting this to 'true' enforces status checks for repository administrators. | +| ForcePushBypassers | string[] | The list of actor Names/IDs that are allowed to bypass force push restrictions. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#id BranchProtection#id}. | +| LockBranch | bool\|Io.Cdktn.IResolvable | Setting this to 'true' will make the branch read-only and preventing any pushes to it. | +| RequireConversationResolution | bool\|Io.Cdktn.IResolvable | Setting this to 'true' requires all conversations on code must be resolved before a pull request can be merged. | +| RequiredLinearHistory | bool\|Io.Cdktn.IResolvable | Setting this to 'true' enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. | +| RequiredPullRequestReviews | Io.Cdktn.IResolvable\|BranchProtectionRequiredPullRequestReviews[] | required_pull_request_reviews block. | +| RequiredStatusChecks | Io.Cdktn.IResolvable\|BranchProtectionRequiredStatusChecks[] | required_status_checks block. | +| RequireSignedCommits | bool\|Io.Cdktn.IResolvable | Setting this to 'true' requires all commits to be signed with GPG. | +| RestrictPushes | Io.Cdktn.IResolvable\|BranchProtectionRestrictPushes[] | restrict_pushes block. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; set; } +``` + +- *Type:* string + +Identifies the protection rule pattern. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#pattern BranchProtection#pattern} + +--- + +##### `RepositoryId`Required + +```csharp +public string RepositoryId { get; set; } +``` + +- *Type:* string + +The name or node ID of the repository associated with this branch protection rule. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#repository_id BranchProtection#repository_id} + +--- + +##### `AllowsDeletions`Optional + +```csharp +public bool|IResolvable AllowsDeletions { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Setting this to 'true' to allow the branch to be deleted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#allows_deletions BranchProtection#allows_deletions} + +--- + +##### `AllowsForcePushes`Optional + +```csharp +public bool|IResolvable AllowsForcePushes { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Setting this to 'true' to allow force pushes on the branch. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#allows_force_pushes BranchProtection#allows_force_pushes} + +--- + +##### `EnforceAdmins`Optional + +```csharp +public bool|IResolvable EnforceAdmins { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Setting this to 'true' enforces status checks for repository administrators. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#enforce_admins BranchProtection#enforce_admins} + +--- + +##### `ForcePushBypassers`Optional + +```csharp +public string[] ForcePushBypassers { get; set; } +``` + +- *Type:* string[] + +The list of actor Names/IDs that are allowed to bypass force push restrictions. + +Actor names must either begin with a '/' for users or the organization name followed by a '/' for teams. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#force_push_bypassers BranchProtection#force_push_bypassers} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#id BranchProtection#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. + +--- + +##### `LockBranch`Optional + +```csharp +public bool|IResolvable LockBranch { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Setting this to 'true' will make the branch read-only and preventing any pushes to it. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#lock_branch BranchProtection#lock_branch} + +--- + +##### `RequireConversationResolution`Optional + +```csharp +public bool|IResolvable RequireConversationResolution { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Setting this to 'true' requires all conversations on code must be resolved before a pull request can be merged. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#require_conversation_resolution BranchProtection#require_conversation_resolution} + +--- + +##### `RequiredLinearHistory`Optional + +```csharp +public bool|IResolvable RequiredLinearHistory { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Setting this to 'true' enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#required_linear_history BranchProtection#required_linear_history} + +--- + +##### `RequiredPullRequestReviews`Optional + +```csharp +public IResolvable|BranchProtectionRequiredPullRequestReviews[] RequiredPullRequestReviews { get; set; } +``` + +- *Type:* Io.Cdktn.IResolvable|BranchProtectionRequiredPullRequestReviews[] + +required_pull_request_reviews block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#required_pull_request_reviews BranchProtection#required_pull_request_reviews} + +--- + +##### `RequiredStatusChecks`Optional + +```csharp +public IResolvable|BranchProtectionRequiredStatusChecks[] RequiredStatusChecks { get; set; } +``` + +- *Type:* Io.Cdktn.IResolvable|BranchProtectionRequiredStatusChecks[] + +required_status_checks block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#required_status_checks BranchProtection#required_status_checks} + +--- + +##### `RequireSignedCommits`Optional + +```csharp +public bool|IResolvable RequireSignedCommits { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Setting this to 'true' requires all commits to be signed with GPG. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#require_signed_commits BranchProtection#require_signed_commits} + +--- + +##### `RestrictPushes`Optional + +```csharp +public IResolvable|BranchProtectionRestrictPushes[] RestrictPushes { get; set; } +``` + +- *Type:* Io.Cdktn.IResolvable|BranchProtectionRestrictPushes[] + +restrict_pushes block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#restrict_pushes BranchProtection#restrict_pushes} + +--- + +### BranchProtectionRequiredPullRequestReviews + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchProtectionRequiredPullRequestReviews { + string[] DismissalRestrictions = null, + bool|IResolvable DismissStaleReviews = null, + string[] PullRequestBypassers = null, + bool|IResolvable RequireCodeOwnerReviews = null, + double RequiredApprovingReviewCount = null, + bool|IResolvable RequireLastPushApproval = null, + bool|IResolvable RestrictDismissals = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| DismissalRestrictions | string[] | The list of actor Names/IDs with dismissal access. | +| DismissStaleReviews | bool\|Io.Cdktn.IResolvable | Dismiss approved reviews automatically when a new commit is pushed. | +| PullRequestBypassers | string[] | The list of actor Names/IDs that are allowed to bypass pull request requirements. | +| RequireCodeOwnerReviews | bool\|Io.Cdktn.IResolvable | Require an approved review in pull requests including files with a designated code owner. | +| RequiredApprovingReviewCount | double | Require 'x' number of approvals to satisfy branch protection requirements. | +| RequireLastPushApproval | bool\|Io.Cdktn.IResolvable | Require that The most recent push must be approved by someone other than the last pusher. | +| RestrictDismissals | bool\|Io.Cdktn.IResolvable | Restrict pull request review dismissals. | + +--- + +##### `DismissalRestrictions`Optional + +```csharp +public string[] DismissalRestrictions { get; set; } +``` + +- *Type:* string[] + +The list of actor Names/IDs with dismissal access. + +If not empty, 'restrict_dismissals' is ignored. Actor names must either begin with a '/' for users or the organization name followed by a '/' for teams. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#dismissal_restrictions BranchProtection#dismissal_restrictions} + +--- + +##### `DismissStaleReviews`Optional + +```csharp +public bool|IResolvable DismissStaleReviews { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Dismiss approved reviews automatically when a new commit is pushed. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#dismiss_stale_reviews BranchProtection#dismiss_stale_reviews} + +--- + +##### `PullRequestBypassers`Optional + +```csharp +public string[] PullRequestBypassers { get; set; } +``` + +- *Type:* string[] + +The list of actor Names/IDs that are allowed to bypass pull request requirements. + +Actor names must either begin with a '/' for users or the organization name followed by a '/' for teams. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#pull_request_bypassers BranchProtection#pull_request_bypassers} + +--- + +##### `RequireCodeOwnerReviews`Optional + +```csharp +public bool|IResolvable RequireCodeOwnerReviews { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Require an approved review in pull requests including files with a designated code owner. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#require_code_owner_reviews BranchProtection#require_code_owner_reviews} + +--- + +##### `RequiredApprovingReviewCount`Optional + +```csharp +public double RequiredApprovingReviewCount { get; set; } +``` + +- *Type:* double + +Require 'x' number of approvals to satisfy branch protection requirements. + +If this is specified it must be a number between 0-6. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#required_approving_review_count BranchProtection#required_approving_review_count} + +--- + +##### `RequireLastPushApproval`Optional + +```csharp +public bool|IResolvable RequireLastPushApproval { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Require that The most recent push must be approved by someone other than the last pusher. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#require_last_push_approval BranchProtection#require_last_push_approval} + +--- + +##### `RestrictDismissals`Optional + +```csharp +public bool|IResolvable RestrictDismissals { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Restrict pull request review dismissals. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#restrict_dismissals BranchProtection#restrict_dismissals} + +--- + +### BranchProtectionRequiredStatusChecks + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchProtectionRequiredStatusChecks { + string[] Contexts = null, + bool|IResolvable Strict = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Contexts | string[] | The list of status checks to require in order to merge into this branch. | +| Strict | bool\|Io.Cdktn.IResolvable | Require branches to be up to date before merging. | + +--- + +##### `Contexts`Optional + +```csharp +public string[] Contexts { get; set; } +``` + +- *Type:* string[] + +The list of status checks to require in order to merge into this branch. + +No status checks are required by default. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#contexts BranchProtection#contexts} + +--- + +##### `Strict`Optional + +```csharp +public bool|IResolvable Strict { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Require branches to be up to date before merging. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#strict BranchProtection#strict} + +--- + +### BranchProtectionRestrictPushes + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchProtectionRestrictPushes { + bool|IResolvable BlocksCreations = null, + string[] PushAllowances = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| BlocksCreations | bool\|Io.Cdktn.IResolvable | Restrict pushes that create matching branches. | +| PushAllowances | string[] | The list of actor Names/IDs that may push to the branch. | + +--- + +##### `BlocksCreations`Optional + +```csharp +public bool|IResolvable BlocksCreations { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Restrict pushes that create matching branches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#blocks_creations BranchProtection#blocks_creations} + +--- + +##### `PushAllowances`Optional + +```csharp +public string[] PushAllowances { get; set; } +``` + +- *Type:* string[] + +The list of actor Names/IDs that may push to the branch. + +Actor names must either begin with a '/' for users or the organization name followed by a '/' for teams. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#push_allowances BranchProtection#push_allowances} + +--- + +## Classes + +### BranchProtectionRequiredPullRequestReviewsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchProtectionRequiredPullRequestReviewsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private BranchProtectionRequiredPullRequestReviewsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|BranchProtectionRequiredPullRequestReviews[] | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|BranchProtectionRequiredPullRequestReviews[] InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|BranchProtectionRequiredPullRequestReviews[] + +--- + + +### BranchProtectionRequiredPullRequestReviewsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchProtectionRequiredPullRequestReviewsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetDismissalRestrictions | *No description.* | +| ResetDismissStaleReviews | *No description.* | +| ResetPullRequestBypassers | *No description.* | +| ResetRequireCodeOwnerReviews | *No description.* | +| ResetRequiredApprovingReviewCount | *No description.* | +| ResetRequireLastPushApproval | *No description.* | +| ResetRestrictDismissals | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetDismissalRestrictions` + +```csharp +private void ResetDismissalRestrictions() +``` + +##### `ResetDismissStaleReviews` + +```csharp +private void ResetDismissStaleReviews() +``` + +##### `ResetPullRequestBypassers` + +```csharp +private void ResetPullRequestBypassers() +``` + +##### `ResetRequireCodeOwnerReviews` + +```csharp +private void ResetRequireCodeOwnerReviews() +``` + +##### `ResetRequiredApprovingReviewCount` + +```csharp +private void ResetRequiredApprovingReviewCount() +``` + +##### `ResetRequireLastPushApproval` + +```csharp +private void ResetRequireLastPushApproval() +``` + +##### `ResetRestrictDismissals` + +```csharp +private void ResetRestrictDismissals() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| DismissalRestrictionsInput | string[] | *No description.* | +| DismissStaleReviewsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| PullRequestBypassersInput | string[] | *No description.* | +| RequireCodeOwnerReviewsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequiredApprovingReviewCountInput | double | *No description.* | +| RequireLastPushApprovalInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RestrictDismissalsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| DismissalRestrictions | string[] | *No description.* | +| DismissStaleReviews | bool\|Io.Cdktn.IResolvable | *No description.* | +| PullRequestBypassers | string[] | *No description.* | +| RequireCodeOwnerReviews | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequiredApprovingReviewCount | double | *No description.* | +| RequireLastPushApproval | bool\|Io.Cdktn.IResolvable | *No description.* | +| RestrictDismissals | bool\|Io.Cdktn.IResolvable | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|BranchProtectionRequiredPullRequestReviews | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `DismissalRestrictionsInput`Optional + +```csharp +public string[] DismissalRestrictionsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `DismissStaleReviewsInput`Optional + +```csharp +public bool|IResolvable DismissStaleReviewsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `PullRequestBypassersInput`Optional + +```csharp +public string[] PullRequestBypassersInput { get; } +``` + +- *Type:* string[] + +--- + +##### `RequireCodeOwnerReviewsInput`Optional + +```csharp +public bool|IResolvable RequireCodeOwnerReviewsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequiredApprovingReviewCountInput`Optional + +```csharp +public double RequiredApprovingReviewCountInput { get; } +``` + +- *Type:* double + +--- + +##### `RequireLastPushApprovalInput`Optional + +```csharp +public bool|IResolvable RequireLastPushApprovalInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RestrictDismissalsInput`Optional + +```csharp +public bool|IResolvable RestrictDismissalsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `DismissalRestrictions`Required + +```csharp +public string[] DismissalRestrictions { get; } +``` + +- *Type:* string[] + +--- + +##### `DismissStaleReviews`Required + +```csharp +public bool|IResolvable DismissStaleReviews { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `PullRequestBypassers`Required + +```csharp +public string[] PullRequestBypassers { get; } +``` + +- *Type:* string[] + +--- + +##### `RequireCodeOwnerReviews`Required + +```csharp +public bool|IResolvable RequireCodeOwnerReviews { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequiredApprovingReviewCount`Required + +```csharp +public double RequiredApprovingReviewCount { get; } +``` + +- *Type:* double + +--- + +##### `RequireLastPushApproval`Required + +```csharp +public bool|IResolvable RequireLastPushApproval { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RestrictDismissals`Required + +```csharp +public bool|IResolvable RestrictDismissals { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|BranchProtectionRequiredPullRequestReviews InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|BranchProtectionRequiredPullRequestReviews + +--- + + +### BranchProtectionRequiredStatusChecksList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchProtectionRequiredStatusChecksList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private BranchProtectionRequiredStatusChecksOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|BranchProtectionRequiredStatusChecks[] | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|BranchProtectionRequiredStatusChecks[] InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|BranchProtectionRequiredStatusChecks[] + +--- + + +### BranchProtectionRequiredStatusChecksOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchProtectionRequiredStatusChecksOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetContexts | *No description.* | +| ResetStrict | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetContexts` + +```csharp +private void ResetContexts() +``` + +##### `ResetStrict` + +```csharp +private void ResetStrict() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| ContextsInput | string[] | *No description.* | +| StrictInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| Contexts | string[] | *No description.* | +| Strict | bool\|Io.Cdktn.IResolvable | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|BranchProtectionRequiredStatusChecks | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `ContextsInput`Optional + +```csharp +public string[] ContextsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `StrictInput`Optional + +```csharp +public bool|IResolvable StrictInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Contexts`Required + +```csharp +public string[] Contexts { get; } +``` + +- *Type:* string[] + +--- + +##### `Strict`Required + +```csharp +public bool|IResolvable Strict { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|BranchProtectionRequiredStatusChecks InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|BranchProtectionRequiredStatusChecks + +--- + + +### BranchProtectionRestrictPushesList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchProtectionRestrictPushesList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private BranchProtectionRestrictPushesOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|BranchProtectionRestrictPushes[] | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|BranchProtectionRestrictPushes[] InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|BranchProtectionRestrictPushes[] + +--- + + +### BranchProtectionRestrictPushesOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchProtectionRestrictPushesOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetBlocksCreations | *No description.* | +| ResetPushAllowances | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetBlocksCreations` + +```csharp +private void ResetBlocksCreations() +``` + +##### `ResetPushAllowances` + +```csharp +private void ResetPushAllowances() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| BlocksCreationsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| PushAllowancesInput | string[] | *No description.* | +| BlocksCreations | bool\|Io.Cdktn.IResolvable | *No description.* | +| PushAllowances | string[] | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|BranchProtectionRestrictPushes | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `BlocksCreationsInput`Optional + +```csharp +public bool|IResolvable BlocksCreationsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `PushAllowancesInput`Optional + +```csharp +public string[] PushAllowancesInput { get; } +``` + +- *Type:* string[] + +--- + +##### `BlocksCreations`Required + +```csharp +public bool|IResolvable BlocksCreations { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `PushAllowances`Required + +```csharp +public string[] PushAllowances { get; } +``` + +- *Type:* string[] + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|BranchProtectionRestrictPushes InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|BranchProtectionRestrictPushes + +--- + + + diff --git a/docs/branchProtection.java.md b/docs/branchProtection.java.md new file mode 100644 index 000000000..bd93f98c2 --- /dev/null +++ b/docs/branchProtection.java.md @@ -0,0 +1,3512 @@ +# `branchProtection` Submodule + +## Constructs + +### BranchProtection + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection github_branch_protection}. + +#### Initializers + +```java +import io.cdktn.providers.github.branch_protection.BranchProtection; + +BranchProtection.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .pattern(java.lang.String) + .repositoryId(java.lang.String) +// .allowsDeletions(java.lang.Boolean|IResolvable) +// .allowsForcePushes(java.lang.Boolean|IResolvable) +// .enforceAdmins(java.lang.Boolean|IResolvable) +// .forcePushBypassers(java.util.List) +// .id(java.lang.String) +// .lockBranch(java.lang.Boolean|IResolvable) +// .requireConversationResolution(java.lang.Boolean|IResolvable) +// .requiredLinearHistory(java.lang.Boolean|IResolvable) +// .requiredPullRequestReviews(IResolvable|java.util.List) +// .requiredStatusChecks(IResolvable|java.util.List) +// .requireSignedCommits(java.lang.Boolean|IResolvable) +// .restrictPushes(IResolvable|java.util.List) + .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 | *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 | *No description.* | +| pattern | java.lang.String | Identifies the protection rule pattern. | +| repositoryId | java.lang.String | The name or node ID of the repository associated with this branch protection rule. | +| allowsDeletions | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Setting this to 'true' to allow the branch to be deleted. | +| allowsForcePushes | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Setting this to 'true' to allow force pushes on the branch. | +| enforceAdmins | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Setting this to 'true' enforces status checks for repository administrators. | +| forcePushBypassers | java.util.List | The list of actor Names/IDs that are allowed to bypass force push restrictions. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#id BranchProtection#id}. | +| lockBranch | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Setting this to 'true' will make the branch read-only and preventing any pushes to it. | +| requireConversationResolution | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Setting this to 'true' requires all conversations on code must be resolved before a pull request can be merged. | +| requiredLinearHistory | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Setting this to 'true' enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. | +| requiredPullRequestReviews | io.cdktn.cdktn.IResolvable\|java.util.List<BranchProtectionRequiredPullRequestReviews> | required_pull_request_reviews block. | +| requiredStatusChecks | io.cdktn.cdktn.IResolvable\|java.util.List<BranchProtectionRequiredStatusChecks> | required_status_checks block. | +| requireSignedCommits | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Setting this to 'true' requires all commits to be signed with GPG. | +| restrictPushes | io.cdktn.cdktn.IResolvable\|java.util.List<BranchProtectionRestrictPushes> | restrict_pushes block. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `pattern`Required + +- *Type:* java.lang.String + +Identifies the protection rule pattern. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#pattern BranchProtection#pattern} + +--- + +##### `repositoryId`Required + +- *Type:* java.lang.String + +The name or node ID of the repository associated with this branch protection rule. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#repository_id BranchProtection#repository_id} + +--- + +##### `allowsDeletions`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Setting this to 'true' to allow the branch to be deleted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#allows_deletions BranchProtection#allows_deletions} + +--- + +##### `allowsForcePushes`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Setting this to 'true' to allow force pushes on the branch. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#allows_force_pushes BranchProtection#allows_force_pushes} + +--- + +##### `enforceAdmins`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Setting this to 'true' enforces status checks for repository administrators. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#enforce_admins BranchProtection#enforce_admins} + +--- + +##### `forcePushBypassers`Optional + +- *Type:* java.util.List + +The list of actor Names/IDs that are allowed to bypass force push restrictions. + +Actor names must either begin with a '/' for users or the organization name followed by a '/' for teams. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#force_push_bypassers BranchProtection#force_push_bypassers} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#id BranchProtection#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. + +--- + +##### `lockBranch`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Setting this to 'true' will make the branch read-only and preventing any pushes to it. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#lock_branch BranchProtection#lock_branch} + +--- + +##### `requireConversationResolution`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Setting this to 'true' requires all conversations on code must be resolved before a pull request can be merged. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#require_conversation_resolution BranchProtection#require_conversation_resolution} + +--- + +##### `requiredLinearHistory`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Setting this to 'true' enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#required_linear_history BranchProtection#required_linear_history} + +--- + +##### `requiredPullRequestReviews`Optional + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<BranchProtectionRequiredPullRequestReviews> + +required_pull_request_reviews block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#required_pull_request_reviews BranchProtection#required_pull_request_reviews} + +--- + +##### `requiredStatusChecks`Optional + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<BranchProtectionRequiredStatusChecks> + +required_status_checks block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#required_status_checks BranchProtection#required_status_checks} + +--- + +##### `requireSignedCommits`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Setting this to 'true' requires all commits to be signed with GPG. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#require_signed_commits BranchProtection#require_signed_commits} + +--- + +##### `restrictPushes`Optional + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<BranchProtectionRestrictPushes> + +restrict_pushes block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#restrict_pushes BranchProtection#restrict_pushes} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| putRequiredPullRequestReviews | *No description.* | +| putRequiredStatusChecks | *No description.* | +| putRestrictPushes | *No description.* | +| resetAllowsDeletions | *No description.* | +| resetAllowsForcePushes | *No description.* | +| resetEnforceAdmins | *No description.* | +| resetForcePushBypassers | *No description.* | +| resetId | *No description.* | +| resetLockBranch | *No description.* | +| resetRequireConversationResolution | *No description.* | +| resetRequiredLinearHistory | *No description.* | +| resetRequiredPullRequestReviews | *No description.* | +| resetRequiredStatusChecks | *No description.* | +| resetRequireSignedCommits | *No description.* | +| resetRestrictPushes | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `putRequiredPullRequestReviews` + +```java +public void putRequiredPullRequestReviews(IResolvable|java.util.List value) +``` + +###### `value`Required + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<BranchProtectionRequiredPullRequestReviews> + +--- + +##### `putRequiredStatusChecks` + +```java +public void putRequiredStatusChecks(IResolvable|java.util.List value) +``` + +###### `value`Required + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<BranchProtectionRequiredStatusChecks> + +--- + +##### `putRestrictPushes` + +```java +public void putRestrictPushes(IResolvable|java.util.List value) +``` + +###### `value`Required + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<BranchProtectionRestrictPushes> + +--- + +##### `resetAllowsDeletions` + +```java +public void resetAllowsDeletions() +``` + +##### `resetAllowsForcePushes` + +```java +public void resetAllowsForcePushes() +``` + +##### `resetEnforceAdmins` + +```java +public void resetEnforceAdmins() +``` + +##### `resetForcePushBypassers` + +```java +public void resetForcePushBypassers() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetLockBranch` + +```java +public void resetLockBranch() +``` + +##### `resetRequireConversationResolution` + +```java +public void resetRequireConversationResolution() +``` + +##### `resetRequiredLinearHistory` + +```java +public void resetRequiredLinearHistory() +``` + +##### `resetRequiredPullRequestReviews` + +```java +public void resetRequiredPullRequestReviews() +``` + +##### `resetRequiredStatusChecks` + +```java +public void resetRequiredStatusChecks() +``` + +##### `resetRequireSignedCommits` + +```java +public void resetRequireSignedCommits() +``` + +##### `resetRestrictPushes` + +```java +public void resetRestrictPushes() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a BranchProtection resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.branch_protection.BranchProtection; + +BranchProtection.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` + +```java +import io.cdktn.providers.github.branch_protection.BranchProtection; + +BranchProtection.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.branch_protection.BranchProtection; + +BranchProtection.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.branch_protection.BranchProtection; + +BranchProtection.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),BranchProtection.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a BranchProtection 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 BranchProtection to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing BranchProtection that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#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 BranchProtection 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| requiredPullRequestReviews | BranchProtectionRequiredPullRequestReviewsList | *No description.* | +| requiredStatusChecks | BranchProtectionRequiredStatusChecksList | *No description.* | +| restrictPushes | BranchProtectionRestrictPushesList | *No description.* | +| allowsDeletionsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| allowsForcePushesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| enforceAdminsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| forcePushBypassersInput | java.util.List | *No description.* | +| idInput | java.lang.String | *No description.* | +| lockBranchInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| patternInput | java.lang.String | *No description.* | +| repositoryIdInput | java.lang.String | *No description.* | +| requireConversationResolutionInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requiredLinearHistoryInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requiredPullRequestReviewsInput | io.cdktn.cdktn.IResolvable\|java.util.List<BranchProtectionRequiredPullRequestReviews> | *No description.* | +| requiredStatusChecksInput | io.cdktn.cdktn.IResolvable\|java.util.List<BranchProtectionRequiredStatusChecks> | *No description.* | +| requireSignedCommitsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| restrictPushesInput | io.cdktn.cdktn.IResolvable\|java.util.List<BranchProtectionRestrictPushes> | *No description.* | +| allowsDeletions | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| allowsForcePushes | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| enforceAdmins | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| forcePushBypassers | java.util.List | *No description.* | +| id | java.lang.String | *No description.* | +| lockBranch | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| pattern | java.lang.String | *No description.* | +| repositoryId | java.lang.String | *No description.* | +| requireConversationResolution | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requiredLinearHistory | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requireSignedCommits | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `requiredPullRequestReviews`Required + +```java +public BranchProtectionRequiredPullRequestReviewsList getRequiredPullRequestReviews(); +``` + +- *Type:* BranchProtectionRequiredPullRequestReviewsList + +--- + +##### `requiredStatusChecks`Required + +```java +public BranchProtectionRequiredStatusChecksList getRequiredStatusChecks(); +``` + +- *Type:* BranchProtectionRequiredStatusChecksList + +--- + +##### `restrictPushes`Required + +```java +public BranchProtectionRestrictPushesList getRestrictPushes(); +``` + +- *Type:* BranchProtectionRestrictPushesList + +--- + +##### `allowsDeletionsInput`Optional + +```java +public java.lang.Boolean|IResolvable getAllowsDeletionsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `allowsForcePushesInput`Optional + +```java +public java.lang.Boolean|IResolvable getAllowsForcePushesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `enforceAdminsInput`Optional + +```java +public java.lang.Boolean|IResolvable getEnforceAdminsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `forcePushBypassersInput`Optional + +```java +public java.util.List getForcePushBypassersInput(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `lockBranchInput`Optional + +```java +public java.lang.Boolean|IResolvable getLockBranchInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `patternInput`Optional + +```java +public java.lang.String getPatternInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryIdInput`Optional + +```java +public java.lang.String getRepositoryIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `requireConversationResolutionInput`Optional + +```java +public java.lang.Boolean|IResolvable getRequireConversationResolutionInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requiredLinearHistoryInput`Optional + +```java +public java.lang.Boolean|IResolvable getRequiredLinearHistoryInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requiredPullRequestReviewsInput`Optional + +```java +public IResolvable|java.util.List getRequiredPullRequestReviewsInput(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<BranchProtectionRequiredPullRequestReviews> + +--- + +##### `requiredStatusChecksInput`Optional + +```java +public IResolvable|java.util.List getRequiredStatusChecksInput(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<BranchProtectionRequiredStatusChecks> + +--- + +##### `requireSignedCommitsInput`Optional + +```java +public java.lang.Boolean|IResolvable getRequireSignedCommitsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `restrictPushesInput`Optional + +```java +public IResolvable|java.util.List getRestrictPushesInput(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<BranchProtectionRestrictPushes> + +--- + +##### `allowsDeletions`Required + +```java +public java.lang.Boolean|IResolvable getAllowsDeletions(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `allowsForcePushes`Required + +```java +public java.lang.Boolean|IResolvable getAllowsForcePushes(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `enforceAdmins`Required + +```java +public java.lang.Boolean|IResolvable getEnforceAdmins(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `forcePushBypassers`Required + +```java +public java.util.List getForcePushBypassers(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `lockBranch`Required + +```java +public java.lang.Boolean|IResolvable getLockBranch(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryId`Required + +```java +public java.lang.String getRepositoryId(); +``` + +- *Type:* java.lang.String + +--- + +##### `requireConversationResolution`Required + +```java +public java.lang.Boolean|IResolvable getRequireConversationResolution(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requiredLinearHistory`Required + +```java +public java.lang.Boolean|IResolvable getRequiredLinearHistory(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requireSignedCommits`Required + +```java +public java.lang.Boolean|IResolvable getRequireSignedCommits(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### BranchProtectionConfig + +#### Initializer + +```java +import io.cdktn.providers.github.branch_protection.BranchProtectionConfig; + +BranchProtectionConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .pattern(java.lang.String) + .repositoryId(java.lang.String) +// .allowsDeletions(java.lang.Boolean|IResolvable) +// .allowsForcePushes(java.lang.Boolean|IResolvable) +// .enforceAdmins(java.lang.Boolean|IResolvable) +// .forcePushBypassers(java.util.List) +// .id(java.lang.String) +// .lockBranch(java.lang.Boolean|IResolvable) +// .requireConversationResolution(java.lang.Boolean|IResolvable) +// .requiredLinearHistory(java.lang.Boolean|IResolvable) +// .requiredPullRequestReviews(IResolvable|java.util.List) +// .requiredStatusChecks(IResolvable|java.util.List) +// .requireSignedCommits(java.lang.Boolean|IResolvable) +// .restrictPushes(IResolvable|java.util.List) + .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 | *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 | *No description.* | +| pattern | java.lang.String | Identifies the protection rule pattern. | +| repositoryId | java.lang.String | The name or node ID of the repository associated with this branch protection rule. | +| allowsDeletions | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Setting this to 'true' to allow the branch to be deleted. | +| allowsForcePushes | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Setting this to 'true' to allow force pushes on the branch. | +| enforceAdmins | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Setting this to 'true' enforces status checks for repository administrators. | +| forcePushBypassers | java.util.List | The list of actor Names/IDs that are allowed to bypass force push restrictions. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#id BranchProtection#id}. | +| lockBranch | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Setting this to 'true' will make the branch read-only and preventing any pushes to it. | +| requireConversationResolution | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Setting this to 'true' requires all conversations on code must be resolved before a pull request can be merged. | +| requiredLinearHistory | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Setting this to 'true' enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. | +| requiredPullRequestReviews | io.cdktn.cdktn.IResolvable\|java.util.List<BranchProtectionRequiredPullRequestReviews> | required_pull_request_reviews block. | +| requiredStatusChecks | io.cdktn.cdktn.IResolvable\|java.util.List<BranchProtectionRequiredStatusChecks> | required_status_checks block. | +| requireSignedCommits | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Setting this to 'true' requires all commits to be signed with GPG. | +| restrictPushes | io.cdktn.cdktn.IResolvable\|java.util.List<BranchProtectionRestrictPushes> | restrict_pushes block. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +Identifies the protection rule pattern. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#pattern BranchProtection#pattern} + +--- + +##### `repositoryId`Required + +```java +public java.lang.String getRepositoryId(); +``` + +- *Type:* java.lang.String + +The name or node ID of the repository associated with this branch protection rule. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#repository_id BranchProtection#repository_id} + +--- + +##### `allowsDeletions`Optional + +```java +public java.lang.Boolean|IResolvable getAllowsDeletions(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Setting this to 'true' to allow the branch to be deleted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#allows_deletions BranchProtection#allows_deletions} + +--- + +##### `allowsForcePushes`Optional + +```java +public java.lang.Boolean|IResolvable getAllowsForcePushes(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Setting this to 'true' to allow force pushes on the branch. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#allows_force_pushes BranchProtection#allows_force_pushes} + +--- + +##### `enforceAdmins`Optional + +```java +public java.lang.Boolean|IResolvable getEnforceAdmins(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Setting this to 'true' enforces status checks for repository administrators. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#enforce_admins BranchProtection#enforce_admins} + +--- + +##### `forcePushBypassers`Optional + +```java +public java.util.List getForcePushBypassers(); +``` + +- *Type:* java.util.List + +The list of actor Names/IDs that are allowed to bypass force push restrictions. + +Actor names must either begin with a '/' for users or the organization name followed by a '/' for teams. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#force_push_bypassers BranchProtection#force_push_bypassers} + +--- + +##### `id`Optional + +```java +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/resources/branch_protection#id BranchProtection#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. + +--- + +##### `lockBranch`Optional + +```java +public java.lang.Boolean|IResolvable getLockBranch(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Setting this to 'true' will make the branch read-only and preventing any pushes to it. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#lock_branch BranchProtection#lock_branch} + +--- + +##### `requireConversationResolution`Optional + +```java +public java.lang.Boolean|IResolvable getRequireConversationResolution(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Setting this to 'true' requires all conversations on code must be resolved before a pull request can be merged. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#require_conversation_resolution BranchProtection#require_conversation_resolution} + +--- + +##### `requiredLinearHistory`Optional + +```java +public java.lang.Boolean|IResolvable getRequiredLinearHistory(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Setting this to 'true' enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#required_linear_history BranchProtection#required_linear_history} + +--- + +##### `requiredPullRequestReviews`Optional + +```java +public IResolvable|java.util.List getRequiredPullRequestReviews(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<BranchProtectionRequiredPullRequestReviews> + +required_pull_request_reviews block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#required_pull_request_reviews BranchProtection#required_pull_request_reviews} + +--- + +##### `requiredStatusChecks`Optional + +```java +public IResolvable|java.util.List getRequiredStatusChecks(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<BranchProtectionRequiredStatusChecks> + +required_status_checks block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#required_status_checks BranchProtection#required_status_checks} + +--- + +##### `requireSignedCommits`Optional + +```java +public java.lang.Boolean|IResolvable getRequireSignedCommits(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Setting this to 'true' requires all commits to be signed with GPG. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#require_signed_commits BranchProtection#require_signed_commits} + +--- + +##### `restrictPushes`Optional + +```java +public IResolvable|java.util.List getRestrictPushes(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<BranchProtectionRestrictPushes> + +restrict_pushes block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#restrict_pushes BranchProtection#restrict_pushes} + +--- + +### BranchProtectionRequiredPullRequestReviews + +#### Initializer + +```java +import io.cdktn.providers.github.branch_protection.BranchProtectionRequiredPullRequestReviews; + +BranchProtectionRequiredPullRequestReviews.builder() +// .dismissalRestrictions(java.util.List) +// .dismissStaleReviews(java.lang.Boolean|IResolvable) +// .pullRequestBypassers(java.util.List) +// .requireCodeOwnerReviews(java.lang.Boolean|IResolvable) +// .requiredApprovingReviewCount(java.lang.Number) +// .requireLastPushApproval(java.lang.Boolean|IResolvable) +// .restrictDismissals(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| dismissalRestrictions | java.util.List | The list of actor Names/IDs with dismissal access. | +| dismissStaleReviews | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Dismiss approved reviews automatically when a new commit is pushed. | +| pullRequestBypassers | java.util.List | The list of actor Names/IDs that are allowed to bypass pull request requirements. | +| requireCodeOwnerReviews | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Require an approved review in pull requests including files with a designated code owner. | +| requiredApprovingReviewCount | java.lang.Number | Require 'x' number of approvals to satisfy branch protection requirements. | +| requireLastPushApproval | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Require that The most recent push must be approved by someone other than the last pusher. | +| restrictDismissals | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Restrict pull request review dismissals. | + +--- + +##### `dismissalRestrictions`Optional + +```java +public java.util.List getDismissalRestrictions(); +``` + +- *Type:* java.util.List + +The list of actor Names/IDs with dismissal access. + +If not empty, 'restrict_dismissals' is ignored. Actor names must either begin with a '/' for users or the organization name followed by a '/' for teams. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#dismissal_restrictions BranchProtection#dismissal_restrictions} + +--- + +##### `dismissStaleReviews`Optional + +```java +public java.lang.Boolean|IResolvable getDismissStaleReviews(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Dismiss approved reviews automatically when a new commit is pushed. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#dismiss_stale_reviews BranchProtection#dismiss_stale_reviews} + +--- + +##### `pullRequestBypassers`Optional + +```java +public java.util.List getPullRequestBypassers(); +``` + +- *Type:* java.util.List + +The list of actor Names/IDs that are allowed to bypass pull request requirements. + +Actor names must either begin with a '/' for users or the organization name followed by a '/' for teams. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#pull_request_bypassers BranchProtection#pull_request_bypassers} + +--- + +##### `requireCodeOwnerReviews`Optional + +```java +public java.lang.Boolean|IResolvable getRequireCodeOwnerReviews(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Require an approved review in pull requests including files with a designated code owner. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#require_code_owner_reviews BranchProtection#require_code_owner_reviews} + +--- + +##### `requiredApprovingReviewCount`Optional + +```java +public java.lang.Number getRequiredApprovingReviewCount(); +``` + +- *Type:* java.lang.Number + +Require 'x' number of approvals to satisfy branch protection requirements. + +If this is specified it must be a number between 0-6. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#required_approving_review_count BranchProtection#required_approving_review_count} + +--- + +##### `requireLastPushApproval`Optional + +```java +public java.lang.Boolean|IResolvable getRequireLastPushApproval(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Require that The most recent push must be approved by someone other than the last pusher. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#require_last_push_approval BranchProtection#require_last_push_approval} + +--- + +##### `restrictDismissals`Optional + +```java +public java.lang.Boolean|IResolvable getRestrictDismissals(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Restrict pull request review dismissals. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#restrict_dismissals BranchProtection#restrict_dismissals} + +--- + +### BranchProtectionRequiredStatusChecks + +#### Initializer + +```java +import io.cdktn.providers.github.branch_protection.BranchProtectionRequiredStatusChecks; + +BranchProtectionRequiredStatusChecks.builder() +// .contexts(java.util.List) +// .strict(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| contexts | java.util.List | The list of status checks to require in order to merge into this branch. | +| strict | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Require branches to be up to date before merging. | + +--- + +##### `contexts`Optional + +```java +public java.util.List getContexts(); +``` + +- *Type:* java.util.List + +The list of status checks to require in order to merge into this branch. + +No status checks are required by default. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#contexts BranchProtection#contexts} + +--- + +##### `strict`Optional + +```java +public java.lang.Boolean|IResolvable getStrict(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Require branches to be up to date before merging. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#strict BranchProtection#strict} + +--- + +### BranchProtectionRestrictPushes + +#### Initializer + +```java +import io.cdktn.providers.github.branch_protection.BranchProtectionRestrictPushes; + +BranchProtectionRestrictPushes.builder() +// .blocksCreations(java.lang.Boolean|IResolvable) +// .pushAllowances(java.util.List) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| blocksCreations | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Restrict pushes that create matching branches. | +| pushAllowances | java.util.List | The list of actor Names/IDs that may push to the branch. | + +--- + +##### `blocksCreations`Optional + +```java +public java.lang.Boolean|IResolvable getBlocksCreations(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Restrict pushes that create matching branches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#blocks_creations BranchProtection#blocks_creations} + +--- + +##### `pushAllowances`Optional + +```java +public java.util.List getPushAllowances(); +``` + +- *Type:* java.util.List + +The list of actor Names/IDs that may push to the branch. + +Actor names must either begin with a '/' for users or the organization name followed by a '/' for teams. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection#push_allowances BranchProtection#push_allowances} + +--- + +## Classes + +### BranchProtectionRequiredPullRequestReviewsList + +#### Initializers + +```java +import io.cdktn.providers.github.branch_protection.BranchProtectionRequiredPullRequestReviewsList; + +new BranchProtectionRequiredPullRequestReviewsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public BranchProtectionRequiredPullRequestReviewsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|java.util.List<BranchProtectionRequiredPullRequestReviews> | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|java.util.List getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<BranchProtectionRequiredPullRequestReviews> + +--- + + +### BranchProtectionRequiredPullRequestReviewsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.branch_protection.BranchProtectionRequiredPullRequestReviewsOutputReference; + +new BranchProtectionRequiredPullRequestReviewsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetDismissalRestrictions | *No description.* | +| resetDismissStaleReviews | *No description.* | +| resetPullRequestBypassers | *No description.* | +| resetRequireCodeOwnerReviews | *No description.* | +| resetRequiredApprovingReviewCount | *No description.* | +| resetRequireLastPushApproval | *No description.* | +| resetRestrictDismissals | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetDismissalRestrictions` + +```java +public void resetDismissalRestrictions() +``` + +##### `resetDismissStaleReviews` + +```java +public void resetDismissStaleReviews() +``` + +##### `resetPullRequestBypassers` + +```java +public void resetPullRequestBypassers() +``` + +##### `resetRequireCodeOwnerReviews` + +```java +public void resetRequireCodeOwnerReviews() +``` + +##### `resetRequiredApprovingReviewCount` + +```java +public void resetRequiredApprovingReviewCount() +``` + +##### `resetRequireLastPushApproval` + +```java +public void resetRequireLastPushApproval() +``` + +##### `resetRestrictDismissals` + +```java +public void resetRestrictDismissals() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| dismissalRestrictionsInput | java.util.List | *No description.* | +| dismissStaleReviewsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| pullRequestBypassersInput | java.util.List | *No description.* | +| requireCodeOwnerReviewsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requiredApprovingReviewCountInput | java.lang.Number | *No description.* | +| requireLastPushApprovalInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| restrictDismissalsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| dismissalRestrictions | java.util.List | *No description.* | +| dismissStaleReviews | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| pullRequestBypassers | java.util.List | *No description.* | +| requireCodeOwnerReviews | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requiredApprovingReviewCount | java.lang.Number | *No description.* | +| requireLastPushApproval | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| restrictDismissals | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|BranchProtectionRequiredPullRequestReviews | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `dismissalRestrictionsInput`Optional + +```java +public java.util.List getDismissalRestrictionsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `dismissStaleReviewsInput`Optional + +```java +public java.lang.Boolean|IResolvable getDismissStaleReviewsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `pullRequestBypassersInput`Optional + +```java +public java.util.List getPullRequestBypassersInput(); +``` + +- *Type:* java.util.List + +--- + +##### `requireCodeOwnerReviewsInput`Optional + +```java +public java.lang.Boolean|IResolvable getRequireCodeOwnerReviewsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requiredApprovingReviewCountInput`Optional + +```java +public java.lang.Number getRequiredApprovingReviewCountInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `requireLastPushApprovalInput`Optional + +```java +public java.lang.Boolean|IResolvable getRequireLastPushApprovalInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `restrictDismissalsInput`Optional + +```java +public java.lang.Boolean|IResolvable getRestrictDismissalsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `dismissalRestrictions`Required + +```java +public java.util.List getDismissalRestrictions(); +``` + +- *Type:* java.util.List + +--- + +##### `dismissStaleReviews`Required + +```java +public java.lang.Boolean|IResolvable getDismissStaleReviews(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `pullRequestBypassers`Required + +```java +public java.util.List getPullRequestBypassers(); +``` + +- *Type:* java.util.List + +--- + +##### `requireCodeOwnerReviews`Required + +```java +public java.lang.Boolean|IResolvable getRequireCodeOwnerReviews(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requiredApprovingReviewCount`Required + +```java +public java.lang.Number getRequiredApprovingReviewCount(); +``` + +- *Type:* java.lang.Number + +--- + +##### `requireLastPushApproval`Required + +```java +public java.lang.Boolean|IResolvable getRequireLastPushApproval(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `restrictDismissals`Required + +```java +public java.lang.Boolean|IResolvable getRestrictDismissals(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `internalValue`Optional + +```java +public IResolvable|BranchProtectionRequiredPullRequestReviews getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|BranchProtectionRequiredPullRequestReviews + +--- + + +### BranchProtectionRequiredStatusChecksList + +#### Initializers + +```java +import io.cdktn.providers.github.branch_protection.BranchProtectionRequiredStatusChecksList; + +new BranchProtectionRequiredStatusChecksList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public BranchProtectionRequiredStatusChecksOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|java.util.List<BranchProtectionRequiredStatusChecks> | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|java.util.List getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<BranchProtectionRequiredStatusChecks> + +--- + + +### BranchProtectionRequiredStatusChecksOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.branch_protection.BranchProtectionRequiredStatusChecksOutputReference; + +new BranchProtectionRequiredStatusChecksOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetContexts | *No description.* | +| resetStrict | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetContexts` + +```java +public void resetContexts() +``` + +##### `resetStrict` + +```java +public void resetStrict() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| contextsInput | java.util.List | *No description.* | +| strictInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| contexts | java.util.List | *No description.* | +| strict | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|BranchProtectionRequiredStatusChecks | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `contextsInput`Optional + +```java +public java.util.List getContextsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `strictInput`Optional + +```java +public java.lang.Boolean|IResolvable getStrictInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `contexts`Required + +```java +public java.util.List getContexts(); +``` + +- *Type:* java.util.List + +--- + +##### `strict`Required + +```java +public java.lang.Boolean|IResolvable getStrict(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `internalValue`Optional + +```java +public IResolvable|BranchProtectionRequiredStatusChecks getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|BranchProtectionRequiredStatusChecks + +--- + + +### BranchProtectionRestrictPushesList + +#### Initializers + +```java +import io.cdktn.providers.github.branch_protection.BranchProtectionRestrictPushesList; + +new BranchProtectionRestrictPushesList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public BranchProtectionRestrictPushesOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|java.util.List<BranchProtectionRestrictPushes> | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|java.util.List getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<BranchProtectionRestrictPushes> + +--- + + +### BranchProtectionRestrictPushesOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.branch_protection.BranchProtectionRestrictPushesOutputReference; + +new BranchProtectionRestrictPushesOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetBlocksCreations | *No description.* | +| resetPushAllowances | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetBlocksCreations` + +```java +public void resetBlocksCreations() +``` + +##### `resetPushAllowances` + +```java +public void resetPushAllowances() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| blocksCreationsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| pushAllowancesInput | java.util.List | *No description.* | +| blocksCreations | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| pushAllowances | java.util.List | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|BranchProtectionRestrictPushes | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `blocksCreationsInput`Optional + +```java +public java.lang.Boolean|IResolvable getBlocksCreationsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `pushAllowancesInput`Optional + +```java +public java.util.List getPushAllowancesInput(); +``` + +- *Type:* java.util.List + +--- + +##### `blocksCreations`Required + +```java +public java.lang.Boolean|IResolvable getBlocksCreations(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `pushAllowances`Required + +```java +public java.util.List getPushAllowances(); +``` + +- *Type:* java.util.List + +--- + +##### `internalValue`Optional + +```java +public IResolvable|BranchProtectionRestrictPushes getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|BranchProtectionRestrictPushes + +--- + + + diff --git a/docs/branchProtectionV3.csharp.md b/docs/branchProtectionV3.csharp.md new file mode 100644 index 000000000..3e3c3c744 --- /dev/null +++ b/docs/branchProtectionV3.csharp.md @@ -0,0 +1,3167 @@ +# `branchProtectionV3` Submodule + +## Constructs + +### BranchProtectionV3 + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3 github_branch_protection_v3}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchProtectionV3(Construct Scope, string Id, BranchProtectionV3Config Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | BranchProtectionV3Config | *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:* BranchProtectionV3Config + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| PutRequiredPullRequestReviews | *No description.* | +| PutRequiredStatusChecks | *No description.* | +| PutRestrictions | *No description.* | +| ResetEnforceAdmins | *No description.* | +| ResetId | *No description.* | +| ResetRequireConversationResolution | *No description.* | +| ResetRequiredPullRequestReviews | *No description.* | +| ResetRequiredStatusChecks | *No description.* | +| ResetRequireSignedCommits | *No description.* | +| ResetRestrictions | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `PutRequiredPullRequestReviews` + +```csharp +private void PutRequiredPullRequestReviews(BranchProtectionV3RequiredPullRequestReviews Value) +``` + +###### `Value`Required + +- *Type:* BranchProtectionV3RequiredPullRequestReviews + +--- + +##### `PutRequiredStatusChecks` + +```csharp +private void PutRequiredStatusChecks(BranchProtectionV3RequiredStatusChecks Value) +``` + +###### `Value`Required + +- *Type:* BranchProtectionV3RequiredStatusChecks + +--- + +##### `PutRestrictions` + +```csharp +private void PutRestrictions(BranchProtectionV3Restrictions Value) +``` + +###### `Value`Required + +- *Type:* BranchProtectionV3Restrictions + +--- + +##### `ResetEnforceAdmins` + +```csharp +private void ResetEnforceAdmins() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetRequireConversationResolution` + +```csharp +private void ResetRequireConversationResolution() +``` + +##### `ResetRequiredPullRequestReviews` + +```csharp +private void ResetRequiredPullRequestReviews() +``` + +##### `ResetRequiredStatusChecks` + +```csharp +private void ResetRequiredStatusChecks() +``` + +##### `ResetRequireSignedCommits` + +```csharp +private void ResetRequireSignedCommits() +``` + +##### `ResetRestrictions` + +```csharp +private void ResetRestrictions() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a BranchProtectionV3 resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +BranchProtectionV3.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` + +```csharp +using Io.Cdktn.Providers.Github; + +BranchProtectionV3.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +BranchProtectionV3.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +BranchProtectionV3.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a BranchProtectionV3 resource upon running "cdktn 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 BranchProtectionV3 to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing BranchProtectionV3 that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the BranchProtectionV3 to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Etag | string | *No description.* | +| RequiredPullRequestReviews | BranchProtectionV3RequiredPullRequestReviewsOutputReference | *No description.* | +| RequiredStatusChecks | BranchProtectionV3RequiredStatusChecksOutputReference | *No description.* | +| Restrictions | BranchProtectionV3RestrictionsOutputReference | *No description.* | +| BranchInput | string | *No description.* | +| EnforceAdminsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| RequireConversationResolutionInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequiredPullRequestReviewsInput | BranchProtectionV3RequiredPullRequestReviews | *No description.* | +| RequiredStatusChecksInput | BranchProtectionV3RequiredStatusChecks | *No description.* | +| RequireSignedCommitsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RestrictionsInput | BranchProtectionV3Restrictions | *No description.* | +| Branch | string | *No description.* | +| EnforceAdmins | bool\|Io.Cdktn.IResolvable | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | +| RequireConversationResolution | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequireSignedCommits | bool\|Io.Cdktn.IResolvable | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `RequiredPullRequestReviews`Required + +```csharp +public BranchProtectionV3RequiredPullRequestReviewsOutputReference RequiredPullRequestReviews { get; } +``` + +- *Type:* BranchProtectionV3RequiredPullRequestReviewsOutputReference + +--- + +##### `RequiredStatusChecks`Required + +```csharp +public BranchProtectionV3RequiredStatusChecksOutputReference RequiredStatusChecks { get; } +``` + +- *Type:* BranchProtectionV3RequiredStatusChecksOutputReference + +--- + +##### `Restrictions`Required + +```csharp +public BranchProtectionV3RestrictionsOutputReference Restrictions { get; } +``` + +- *Type:* BranchProtectionV3RestrictionsOutputReference + +--- + +##### `BranchInput`Optional + +```csharp +public string BranchInput { get; } +``` + +- *Type:* string + +--- + +##### `EnforceAdminsInput`Optional + +```csharp +public bool|IResolvable EnforceAdminsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `RequireConversationResolutionInput`Optional + +```csharp +public bool|IResolvable RequireConversationResolutionInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequiredPullRequestReviewsInput`Optional + +```csharp +public BranchProtectionV3RequiredPullRequestReviews RequiredPullRequestReviewsInput { get; } +``` + +- *Type:* BranchProtectionV3RequiredPullRequestReviews + +--- + +##### `RequiredStatusChecksInput`Optional + +```csharp +public BranchProtectionV3RequiredStatusChecks RequiredStatusChecksInput { get; } +``` + +- *Type:* BranchProtectionV3RequiredStatusChecks + +--- + +##### `RequireSignedCommitsInput`Optional + +```csharp +public bool|IResolvable RequireSignedCommitsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RestrictionsInput`Optional + +```csharp +public BranchProtectionV3Restrictions RestrictionsInput { get; } +``` + +- *Type:* BranchProtectionV3Restrictions + +--- + +##### `Branch`Required + +```csharp +public string Branch { get; } +``` + +- *Type:* string + +--- + +##### `EnforceAdmins`Required + +```csharp +public bool|IResolvable EnforceAdmins { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `RequireConversationResolution`Required + +```csharp +public bool|IResolvable RequireConversationResolution { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequireSignedCommits`Required + +```csharp +public bool|IResolvable RequireSignedCommits { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### BranchProtectionV3Config + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchProtectionV3Config { + 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 Branch, + string Repository, + bool|IResolvable EnforceAdmins = null, + string Id = null, + bool|IResolvable RequireConversationResolution = null, + BranchProtectionV3RequiredPullRequestReviews RequiredPullRequestReviews = null, + BranchProtectionV3RequiredStatusChecks RequiredStatusChecks = null, + bool|IResolvable RequireSignedCommits = null, + BranchProtectionV3Restrictions Restrictions = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Branch | string | The Git branch to protect. | +| Repository | string | The GitHub repository name. | +| EnforceAdmins | bool\|Io.Cdktn.IResolvable | Setting this to 'true' enforces status checks for repository administrators. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#id BranchProtectionV3#id}. | +| RequireConversationResolution | bool\|Io.Cdktn.IResolvable | Setting this to 'true' requires all conversations on code must be resolved before a pull request can be merged. | +| RequiredPullRequestReviews | BranchProtectionV3RequiredPullRequestReviews | required_pull_request_reviews block. | +| RequiredStatusChecks | BranchProtectionV3RequiredStatusChecks | required_status_checks block. | +| RequireSignedCommits | bool\|Io.Cdktn.IResolvable | Setting this to 'true' requires all commits to be signed with GPG. | +| Restrictions | BranchProtectionV3Restrictions | restrictions block. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Branch`Required + +```csharp +public string Branch { get; set; } +``` + +- *Type:* string + +The Git branch to protect. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#branch BranchProtectionV3#branch} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The GitHub repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#repository BranchProtectionV3#repository} + +--- + +##### `EnforceAdmins`Optional + +```csharp +public bool|IResolvable EnforceAdmins { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Setting this to 'true' enforces status checks for repository administrators. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#enforce_admins BranchProtectionV3#enforce_admins} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#id BranchProtectionV3#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. + +--- + +##### `RequireConversationResolution`Optional + +```csharp +public bool|IResolvable RequireConversationResolution { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Setting this to 'true' requires all conversations on code must be resolved before a pull request can be merged. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#require_conversation_resolution BranchProtectionV3#require_conversation_resolution} + +--- + +##### `RequiredPullRequestReviews`Optional + +```csharp +public BranchProtectionV3RequiredPullRequestReviews RequiredPullRequestReviews { get; set; } +``` + +- *Type:* BranchProtectionV3RequiredPullRequestReviews + +required_pull_request_reviews block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#required_pull_request_reviews BranchProtectionV3#required_pull_request_reviews} + +--- + +##### `RequiredStatusChecks`Optional + +```csharp +public BranchProtectionV3RequiredStatusChecks RequiredStatusChecks { get; set; } +``` + +- *Type:* BranchProtectionV3RequiredStatusChecks + +required_status_checks block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#required_status_checks BranchProtectionV3#required_status_checks} + +--- + +##### `RequireSignedCommits`Optional + +```csharp +public bool|IResolvable RequireSignedCommits { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Setting this to 'true' requires all commits to be signed with GPG. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#require_signed_commits BranchProtectionV3#require_signed_commits} + +--- + +##### `Restrictions`Optional + +```csharp +public BranchProtectionV3Restrictions Restrictions { get; set; } +``` + +- *Type:* BranchProtectionV3Restrictions + +restrictions block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#restrictions BranchProtectionV3#restrictions} + +--- + +### BranchProtectionV3RequiredPullRequestReviews + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchProtectionV3RequiredPullRequestReviews { + BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances BypassPullRequestAllowances = null, + string[] DismissalApps = null, + string[] DismissalTeams = null, + string[] DismissalUsers = null, + bool|IResolvable DismissStaleReviews = null, + bool|IResolvable IncludeAdmins = null, + bool|IResolvable RequireCodeOwnerReviews = null, + double RequiredApprovingReviewCount = null, + bool|IResolvable RequireLastPushApproval = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| BypassPullRequestAllowances | BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances | bypass_pull_request_allowances block. | +| DismissalApps | string[] | The list of apps slugs with dismissal access. | +| DismissalTeams | string[] | The list of team slugs with dismissal access. | +| DismissalUsers | string[] | The list of user logins with dismissal access. | +| DismissStaleReviews | bool\|Io.Cdktn.IResolvable | Dismiss approved reviews automatically when a new commit is pushed. | +| IncludeAdmins | bool\|Io.Cdktn.IResolvable | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#include_admins BranchProtectionV3#include_admins}. | +| RequireCodeOwnerReviews | bool\|Io.Cdktn.IResolvable | Require an approved review in pull requests including files with a designated code owner. | +| RequiredApprovingReviewCount | double | Require 'x' number of approvals to satisfy branch protection requirements. | +| RequireLastPushApproval | bool\|Io.Cdktn.IResolvable | Require that the most recent push must be approved by someone other than the last pusher. | + +--- + +##### `BypassPullRequestAllowances`Optional + +```csharp +public BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances BypassPullRequestAllowances { get; set; } +``` + +- *Type:* BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances + +bypass_pull_request_allowances block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#bypass_pull_request_allowances BranchProtectionV3#bypass_pull_request_allowances} + +--- + +##### `DismissalApps`Optional + +```csharp +public string[] DismissalApps { get; set; } +``` + +- *Type:* string[] + +The list of apps slugs with dismissal access. + +Always use slug of the app, not its name. Each app already has to have access to the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#dismissal_apps BranchProtectionV3#dismissal_apps} + +--- + +##### `DismissalTeams`Optional + +```csharp +public string[] DismissalTeams { get; set; } +``` + +- *Type:* string[] + +The list of team slugs with dismissal access. + +Always use slug of the team, not its name. Each team already has to have access to the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#dismissal_teams BranchProtectionV3#dismissal_teams} + +--- + +##### `DismissalUsers`Optional + +```csharp +public string[] DismissalUsers { get; set; } +``` + +- *Type:* string[] + +The list of user logins with dismissal access. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#dismissal_users BranchProtectionV3#dismissal_users} + +--- + +##### `DismissStaleReviews`Optional + +```csharp +public bool|IResolvable DismissStaleReviews { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Dismiss approved reviews automatically when a new commit is pushed. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#dismiss_stale_reviews BranchProtectionV3#dismiss_stale_reviews} + +--- + +##### `IncludeAdmins`Optional + +```csharp +public bool|IResolvable IncludeAdmins { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#include_admins BranchProtectionV3#include_admins}. + +--- + +##### `RequireCodeOwnerReviews`Optional + +```csharp +public bool|IResolvable RequireCodeOwnerReviews { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Require an approved review in pull requests including files with a designated code owner. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#require_code_owner_reviews BranchProtectionV3#require_code_owner_reviews} + +--- + +##### `RequiredApprovingReviewCount`Optional + +```csharp +public double RequiredApprovingReviewCount { get; set; } +``` + +- *Type:* double + +Require 'x' number of approvals to satisfy branch protection requirements. + +If this is specified it must be a number between 0-6. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#required_approving_review_count BranchProtectionV3#required_approving_review_count} + +--- + +##### `RequireLastPushApproval`Optional + +```csharp +public bool|IResolvable RequireLastPushApproval { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Require that the most recent push must be approved by someone other than the last pusher. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#require_last_push_approval BranchProtectionV3#require_last_push_approval} + +--- + +### BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances { + string[] Apps = null, + string[] Teams = null, + string[] Users = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Apps | string[] | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#apps BranchProtectionV3#apps}. | +| Teams | string[] | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#teams BranchProtectionV3#teams}. | +| Users | string[] | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#users BranchProtectionV3#users}. | + +--- + +##### `Apps`Optional + +```csharp +public string[] Apps { get; set; } +``` + +- *Type:* string[] + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#apps BranchProtectionV3#apps}. + +--- + +##### `Teams`Optional + +```csharp +public string[] Teams { get; set; } +``` + +- *Type:* string[] + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#teams BranchProtectionV3#teams}. + +--- + +##### `Users`Optional + +```csharp +public string[] Users { get; set; } +``` + +- *Type:* string[] + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#users BranchProtectionV3#users}. + +--- + +### BranchProtectionV3RequiredStatusChecks + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchProtectionV3RequiredStatusChecks { + string[] Checks = null, + string[] Contexts = null, + bool|IResolvable IncludeAdmins = null, + bool|IResolvable Strict = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Checks | string[] | The list of status checks to require in order to merge into this branch. | +| Contexts | string[] | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#contexts BranchProtectionV3#contexts}. | +| IncludeAdmins | bool\|Io.Cdktn.IResolvable | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#include_admins BranchProtectionV3#include_admins}. | +| Strict | bool\|Io.Cdktn.IResolvable | Require branches to be up to date before merging. | + +--- + +##### `Checks`Optional + +```csharp +public string[] Checks { get; set; } +``` + +- *Type:* string[] + +The list of status checks to require in order to merge into this branch. + +No status checks are required by default. Checks should be strings containing the 'context' and 'app_id' like so 'context:app_id' + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#checks BranchProtectionV3#checks} + +--- + +##### `Contexts`Optional + +```csharp +public string[] Contexts { get; set; } +``` + +- *Type:* string[] + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#contexts BranchProtectionV3#contexts}. + +--- + +##### `IncludeAdmins`Optional + +```csharp +public bool|IResolvable IncludeAdmins { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#include_admins BranchProtectionV3#include_admins}. + +--- + +##### `Strict`Optional + +```csharp +public bool|IResolvable Strict { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Require branches to be up to date before merging. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#strict BranchProtectionV3#strict} + +--- + +### BranchProtectionV3Restrictions + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchProtectionV3Restrictions { + string[] Apps = null, + string[] Teams = null, + string[] Users = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Apps | string[] | The list of app slugs with push access. | +| Teams | string[] | The list of team slugs with push access. | +| Users | string[] | The list of user logins with push access. | + +--- + +##### `Apps`Optional + +```csharp +public string[] Apps { get; set; } +``` + +- *Type:* string[] + +The list of app slugs with push access. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#apps BranchProtectionV3#apps} + +--- + +##### `Teams`Optional + +```csharp +public string[] Teams { get; set; } +``` + +- *Type:* string[] + +The list of team slugs with push access. + +Always use slug of the team, not its name. Each team already has to have access to the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#teams BranchProtectionV3#teams} + +--- + +##### `Users`Optional + +```csharp +public string[] Users { get; set; } +``` + +- *Type:* string[] + +The list of user logins with push access. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#users BranchProtectionV3#users} + +--- + +## Classes + +### BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetApps | *No description.* | +| ResetTeams | *No description.* | +| ResetUsers | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetApps` + +```csharp +private void ResetApps() +``` + +##### `ResetTeams` + +```csharp +private void ResetTeams() +``` + +##### `ResetUsers` + +```csharp +private void ResetUsers() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| AppsInput | string[] | *No description.* | +| TeamsInput | string[] | *No description.* | +| UsersInput | string[] | *No description.* | +| Apps | string[] | *No description.* | +| Teams | string[] | *No description.* | +| Users | string[] | *No description.* | +| InternalValue | BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `AppsInput`Optional + +```csharp +public string[] AppsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `TeamsInput`Optional + +```csharp +public string[] TeamsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `UsersInput`Optional + +```csharp +public string[] UsersInput { get; } +``` + +- *Type:* string[] + +--- + +##### `Apps`Required + +```csharp +public string[] Apps { get; } +``` + +- *Type:* string[] + +--- + +##### `Teams`Required + +```csharp +public string[] Teams { get; } +``` + +- *Type:* string[] + +--- + +##### `Users`Required + +```csharp +public string[] Users { get; } +``` + +- *Type:* string[] + +--- + +##### `InternalValue`Optional + +```csharp +public BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances InternalValue { get; } +``` + +- *Type:* BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances + +--- + + +### BranchProtectionV3RequiredPullRequestReviewsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchProtectionV3RequiredPullRequestReviewsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| PutBypassPullRequestAllowances | *No description.* | +| ResetBypassPullRequestAllowances | *No description.* | +| ResetDismissalApps | *No description.* | +| ResetDismissalTeams | *No description.* | +| ResetDismissalUsers | *No description.* | +| ResetDismissStaleReviews | *No description.* | +| ResetIncludeAdmins | *No description.* | +| ResetRequireCodeOwnerReviews | *No description.* | +| ResetRequiredApprovingReviewCount | *No description.* | +| ResetRequireLastPushApproval | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `PutBypassPullRequestAllowances` + +```csharp +private void PutBypassPullRequestAllowances(BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances Value) +``` + +###### `Value`Required + +- *Type:* BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances + +--- + +##### `ResetBypassPullRequestAllowances` + +```csharp +private void ResetBypassPullRequestAllowances() +``` + +##### `ResetDismissalApps` + +```csharp +private void ResetDismissalApps() +``` + +##### `ResetDismissalTeams` + +```csharp +private void ResetDismissalTeams() +``` + +##### `ResetDismissalUsers` + +```csharp +private void ResetDismissalUsers() +``` + +##### `ResetDismissStaleReviews` + +```csharp +private void ResetDismissStaleReviews() +``` + +##### `ResetIncludeAdmins` + +```csharp +private void ResetIncludeAdmins() +``` + +##### `ResetRequireCodeOwnerReviews` + +```csharp +private void ResetRequireCodeOwnerReviews() +``` + +##### `ResetRequiredApprovingReviewCount` + +```csharp +private void ResetRequiredApprovingReviewCount() +``` + +##### `ResetRequireLastPushApproval` + +```csharp +private void ResetRequireLastPushApproval() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| BypassPullRequestAllowances | BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference | *No description.* | +| BypassPullRequestAllowancesInput | BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances | *No description.* | +| DismissalAppsInput | string[] | *No description.* | +| DismissalTeamsInput | string[] | *No description.* | +| DismissalUsersInput | string[] | *No description.* | +| DismissStaleReviewsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| IncludeAdminsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequireCodeOwnerReviewsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequiredApprovingReviewCountInput | double | *No description.* | +| RequireLastPushApprovalInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| DismissalApps | string[] | *No description.* | +| DismissalTeams | string[] | *No description.* | +| DismissalUsers | string[] | *No description.* | +| DismissStaleReviews | bool\|Io.Cdktn.IResolvable | *No description.* | +| IncludeAdmins | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequireCodeOwnerReviews | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequiredApprovingReviewCount | double | *No description.* | +| RequireLastPushApproval | bool\|Io.Cdktn.IResolvable | *No description.* | +| InternalValue | BranchProtectionV3RequiredPullRequestReviews | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `BypassPullRequestAllowances`Required + +```csharp +public BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference BypassPullRequestAllowances { get; } +``` + +- *Type:* BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference + +--- + +##### `BypassPullRequestAllowancesInput`Optional + +```csharp +public BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances BypassPullRequestAllowancesInput { get; } +``` + +- *Type:* BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances + +--- + +##### `DismissalAppsInput`Optional + +```csharp +public string[] DismissalAppsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `DismissalTeamsInput`Optional + +```csharp +public string[] DismissalTeamsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `DismissalUsersInput`Optional + +```csharp +public string[] DismissalUsersInput { get; } +``` + +- *Type:* string[] + +--- + +##### `DismissStaleReviewsInput`Optional + +```csharp +public bool|IResolvable DismissStaleReviewsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `IncludeAdminsInput`Optional + +```csharp +public bool|IResolvable IncludeAdminsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequireCodeOwnerReviewsInput`Optional + +```csharp +public bool|IResolvable RequireCodeOwnerReviewsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequiredApprovingReviewCountInput`Optional + +```csharp +public double RequiredApprovingReviewCountInput { get; } +``` + +- *Type:* double + +--- + +##### `RequireLastPushApprovalInput`Optional + +```csharp +public bool|IResolvable RequireLastPushApprovalInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `DismissalApps`Required + +```csharp +public string[] DismissalApps { get; } +``` + +- *Type:* string[] + +--- + +##### `DismissalTeams`Required + +```csharp +public string[] DismissalTeams { get; } +``` + +- *Type:* string[] + +--- + +##### `DismissalUsers`Required + +```csharp +public string[] DismissalUsers { get; } +``` + +- *Type:* string[] + +--- + +##### `DismissStaleReviews`Required + +```csharp +public bool|IResolvable DismissStaleReviews { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `IncludeAdmins`Required + +```csharp +public bool|IResolvable IncludeAdmins { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequireCodeOwnerReviews`Required + +```csharp +public bool|IResolvable RequireCodeOwnerReviews { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequiredApprovingReviewCount`Required + +```csharp +public double RequiredApprovingReviewCount { get; } +``` + +- *Type:* double + +--- + +##### `RequireLastPushApproval`Required + +```csharp +public bool|IResolvable RequireLastPushApproval { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `InternalValue`Optional + +```csharp +public BranchProtectionV3RequiredPullRequestReviews InternalValue { get; } +``` + +- *Type:* BranchProtectionV3RequiredPullRequestReviews + +--- + + +### BranchProtectionV3RequiredStatusChecksOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchProtectionV3RequiredStatusChecksOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetChecks | *No description.* | +| ResetContexts | *No description.* | +| ResetIncludeAdmins | *No description.* | +| ResetStrict | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetChecks` + +```csharp +private void ResetChecks() +``` + +##### `ResetContexts` + +```csharp +private void ResetContexts() +``` + +##### `ResetIncludeAdmins` + +```csharp +private void ResetIncludeAdmins() +``` + +##### `ResetStrict` + +```csharp +private void ResetStrict() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| ChecksInput | string[] | *No description.* | +| ContextsInput | string[] | *No description.* | +| IncludeAdminsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| StrictInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| Checks | string[] | *No description.* | +| Contexts | string[] | *No description.* | +| IncludeAdmins | bool\|Io.Cdktn.IResolvable | *No description.* | +| Strict | bool\|Io.Cdktn.IResolvable | *No description.* | +| InternalValue | BranchProtectionV3RequiredStatusChecks | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `ChecksInput`Optional + +```csharp +public string[] ChecksInput { get; } +``` + +- *Type:* string[] + +--- + +##### `ContextsInput`Optional + +```csharp +public string[] ContextsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `IncludeAdminsInput`Optional + +```csharp +public bool|IResolvable IncludeAdminsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `StrictInput`Optional + +```csharp +public bool|IResolvable StrictInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Checks`Required + +```csharp +public string[] Checks { get; } +``` + +- *Type:* string[] + +--- + +##### `Contexts`Required + +```csharp +public string[] Contexts { get; } +``` + +- *Type:* string[] + +--- + +##### `IncludeAdmins`Required + +```csharp +public bool|IResolvable IncludeAdmins { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Strict`Required + +```csharp +public bool|IResolvable Strict { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `InternalValue`Optional + +```csharp +public BranchProtectionV3RequiredStatusChecks InternalValue { get; } +``` + +- *Type:* BranchProtectionV3RequiredStatusChecks + +--- + + +### BranchProtectionV3RestrictionsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new BranchProtectionV3RestrictionsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetApps | *No description.* | +| ResetTeams | *No description.* | +| ResetUsers | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetApps` + +```csharp +private void ResetApps() +``` + +##### `ResetTeams` + +```csharp +private void ResetTeams() +``` + +##### `ResetUsers` + +```csharp +private void ResetUsers() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| AppsInput | string[] | *No description.* | +| TeamsInput | string[] | *No description.* | +| UsersInput | string[] | *No description.* | +| Apps | string[] | *No description.* | +| Teams | string[] | *No description.* | +| Users | string[] | *No description.* | +| InternalValue | BranchProtectionV3Restrictions | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `AppsInput`Optional + +```csharp +public string[] AppsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `TeamsInput`Optional + +```csharp +public string[] TeamsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `UsersInput`Optional + +```csharp +public string[] UsersInput { get; } +``` + +- *Type:* string[] + +--- + +##### `Apps`Required + +```csharp +public string[] Apps { get; } +``` + +- *Type:* string[] + +--- + +##### `Teams`Required + +```csharp +public string[] Teams { get; } +``` + +- *Type:* string[] + +--- + +##### `Users`Required + +```csharp +public string[] Users { get; } +``` + +- *Type:* string[] + +--- + +##### `InternalValue`Optional + +```csharp +public BranchProtectionV3Restrictions InternalValue { get; } +``` + +- *Type:* BranchProtectionV3Restrictions + +--- + + + diff --git a/docs/branchProtectionV3.java.md b/docs/branchProtectionV3.java.md new file mode 100644 index 000000000..c63181056 --- /dev/null +++ b/docs/branchProtectionV3.java.md @@ -0,0 +1,3328 @@ +# `branchProtectionV3` Submodule + +## Constructs + +### BranchProtectionV3 + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3 github_branch_protection_v3}. + +#### Initializers + +```java +import io.cdktn.providers.github.branch_protection_v3.BranchProtectionV3; + +BranchProtectionV3.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .branch(java.lang.String) + .repository(java.lang.String) +// .enforceAdmins(java.lang.Boolean|IResolvable) +// .id(java.lang.String) +// .requireConversationResolution(java.lang.Boolean|IResolvable) +// .requiredPullRequestReviews(BranchProtectionV3RequiredPullRequestReviews) +// .requiredStatusChecks(BranchProtectionV3RequiredStatusChecks) +// .requireSignedCommits(java.lang.Boolean|IResolvable) +// .restrictions(BranchProtectionV3Restrictions) + .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 | *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 | *No description.* | +| branch | java.lang.String | The Git branch to protect. | +| repository | java.lang.String | The GitHub repository name. | +| enforceAdmins | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Setting this to 'true' enforces status checks for repository administrators. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#id BranchProtectionV3#id}. | +| requireConversationResolution | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Setting this to 'true' requires all conversations on code must be resolved before a pull request can be merged. | +| requiredPullRequestReviews | BranchProtectionV3RequiredPullRequestReviews | required_pull_request_reviews block. | +| requiredStatusChecks | BranchProtectionV3RequiredStatusChecks | required_status_checks block. | +| requireSignedCommits | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Setting this to 'true' requires all commits to be signed with GPG. | +| restrictions | BranchProtectionV3Restrictions | restrictions block. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `branch`Required + +- *Type:* java.lang.String + +The Git branch to protect. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#branch BranchProtectionV3#branch} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The GitHub repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#repository BranchProtectionV3#repository} + +--- + +##### `enforceAdmins`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Setting this to 'true' enforces status checks for repository administrators. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#enforce_admins BranchProtectionV3#enforce_admins} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#id BranchProtectionV3#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. + +--- + +##### `requireConversationResolution`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Setting this to 'true' requires all conversations on code must be resolved before a pull request can be merged. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#require_conversation_resolution BranchProtectionV3#require_conversation_resolution} + +--- + +##### `requiredPullRequestReviews`Optional + +- *Type:* BranchProtectionV3RequiredPullRequestReviews + +required_pull_request_reviews block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#required_pull_request_reviews BranchProtectionV3#required_pull_request_reviews} + +--- + +##### `requiredStatusChecks`Optional + +- *Type:* BranchProtectionV3RequiredStatusChecks + +required_status_checks block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#required_status_checks BranchProtectionV3#required_status_checks} + +--- + +##### `requireSignedCommits`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Setting this to 'true' requires all commits to be signed with GPG. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#require_signed_commits BranchProtectionV3#require_signed_commits} + +--- + +##### `restrictions`Optional + +- *Type:* BranchProtectionV3Restrictions + +restrictions block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#restrictions BranchProtectionV3#restrictions} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| putRequiredPullRequestReviews | *No description.* | +| putRequiredStatusChecks | *No description.* | +| putRestrictions | *No description.* | +| resetEnforceAdmins | *No description.* | +| resetId | *No description.* | +| resetRequireConversationResolution | *No description.* | +| resetRequiredPullRequestReviews | *No description.* | +| resetRequiredStatusChecks | *No description.* | +| resetRequireSignedCommits | *No description.* | +| resetRestrictions | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `putRequiredPullRequestReviews` + +```java +public void putRequiredPullRequestReviews(BranchProtectionV3RequiredPullRequestReviews value) +``` + +###### `value`Required + +- *Type:* BranchProtectionV3RequiredPullRequestReviews + +--- + +##### `putRequiredStatusChecks` + +```java +public void putRequiredStatusChecks(BranchProtectionV3RequiredStatusChecks value) +``` + +###### `value`Required + +- *Type:* BranchProtectionV3RequiredStatusChecks + +--- + +##### `putRestrictions` + +```java +public void putRestrictions(BranchProtectionV3Restrictions value) +``` + +###### `value`Required + +- *Type:* BranchProtectionV3Restrictions + +--- + +##### `resetEnforceAdmins` + +```java +public void resetEnforceAdmins() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetRequireConversationResolution` + +```java +public void resetRequireConversationResolution() +``` + +##### `resetRequiredPullRequestReviews` + +```java +public void resetRequiredPullRequestReviews() +``` + +##### `resetRequiredStatusChecks` + +```java +public void resetRequiredStatusChecks() +``` + +##### `resetRequireSignedCommits` + +```java +public void resetRequireSignedCommits() +``` + +##### `resetRestrictions` + +```java +public void resetRestrictions() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a BranchProtectionV3 resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.branch_protection_v3.BranchProtectionV3; + +BranchProtectionV3.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` + +```java +import io.cdktn.providers.github.branch_protection_v3.BranchProtectionV3; + +BranchProtectionV3.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.branch_protection_v3.BranchProtectionV3; + +BranchProtectionV3.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.branch_protection_v3.BranchProtectionV3; + +BranchProtectionV3.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),BranchProtectionV3.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a BranchProtectionV3 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 BranchProtectionV3 to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing BranchProtectionV3 that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#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 BranchProtectionV3 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| etag | java.lang.String | *No description.* | +| requiredPullRequestReviews | BranchProtectionV3RequiredPullRequestReviewsOutputReference | *No description.* | +| requiredStatusChecks | BranchProtectionV3RequiredStatusChecksOutputReference | *No description.* | +| restrictions | BranchProtectionV3RestrictionsOutputReference | *No description.* | +| branchInput | java.lang.String | *No description.* | +| enforceAdminsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| requireConversationResolutionInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requiredPullRequestReviewsInput | BranchProtectionV3RequiredPullRequestReviews | *No description.* | +| requiredStatusChecksInput | BranchProtectionV3RequiredStatusChecks | *No description.* | +| requireSignedCommitsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| restrictionsInput | BranchProtectionV3Restrictions | *No description.* | +| branch | java.lang.String | *No description.* | +| enforceAdmins | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | +| requireConversationResolution | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requireSignedCommits | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `requiredPullRequestReviews`Required + +```java +public BranchProtectionV3RequiredPullRequestReviewsOutputReference getRequiredPullRequestReviews(); +``` + +- *Type:* BranchProtectionV3RequiredPullRequestReviewsOutputReference + +--- + +##### `requiredStatusChecks`Required + +```java +public BranchProtectionV3RequiredStatusChecksOutputReference getRequiredStatusChecks(); +``` + +- *Type:* BranchProtectionV3RequiredStatusChecksOutputReference + +--- + +##### `restrictions`Required + +```java +public BranchProtectionV3RestrictionsOutputReference getRestrictions(); +``` + +- *Type:* BranchProtectionV3RestrictionsOutputReference + +--- + +##### `branchInput`Optional + +```java +public java.lang.String getBranchInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `enforceAdminsInput`Optional + +```java +public java.lang.Boolean|IResolvable getEnforceAdminsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `requireConversationResolutionInput`Optional + +```java +public java.lang.Boolean|IResolvable getRequireConversationResolutionInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requiredPullRequestReviewsInput`Optional + +```java +public BranchProtectionV3RequiredPullRequestReviews getRequiredPullRequestReviewsInput(); +``` + +- *Type:* BranchProtectionV3RequiredPullRequestReviews + +--- + +##### `requiredStatusChecksInput`Optional + +```java +public BranchProtectionV3RequiredStatusChecks getRequiredStatusChecksInput(); +``` + +- *Type:* BranchProtectionV3RequiredStatusChecks + +--- + +##### `requireSignedCommitsInput`Optional + +```java +public java.lang.Boolean|IResolvable getRequireSignedCommitsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `restrictionsInput`Optional + +```java +public BranchProtectionV3Restrictions getRestrictionsInput(); +``` + +- *Type:* BranchProtectionV3Restrictions + +--- + +##### `branch`Required + +```java +public java.lang.String getBranch(); +``` + +- *Type:* java.lang.String + +--- + +##### `enforceAdmins`Required + +```java +public java.lang.Boolean|IResolvable getEnforceAdmins(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `requireConversationResolution`Required + +```java +public java.lang.Boolean|IResolvable getRequireConversationResolution(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requireSignedCommits`Required + +```java +public java.lang.Boolean|IResolvable getRequireSignedCommits(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### BranchProtectionV3Config + +#### Initializer + +```java +import io.cdktn.providers.github.branch_protection_v3.BranchProtectionV3Config; + +BranchProtectionV3Config.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .branch(java.lang.String) + .repository(java.lang.String) +// .enforceAdmins(java.lang.Boolean|IResolvable) +// .id(java.lang.String) +// .requireConversationResolution(java.lang.Boolean|IResolvable) +// .requiredPullRequestReviews(BranchProtectionV3RequiredPullRequestReviews) +// .requiredStatusChecks(BranchProtectionV3RequiredStatusChecks) +// .requireSignedCommits(java.lang.Boolean|IResolvable) +// .restrictions(BranchProtectionV3Restrictions) + .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 | *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 | *No description.* | +| branch | java.lang.String | The Git branch to protect. | +| repository | java.lang.String | The GitHub repository name. | +| enforceAdmins | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Setting this to 'true' enforces status checks for repository administrators. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#id BranchProtectionV3#id}. | +| requireConversationResolution | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Setting this to 'true' requires all conversations on code must be resolved before a pull request can be merged. | +| requiredPullRequestReviews | BranchProtectionV3RequiredPullRequestReviews | required_pull_request_reviews block. | +| requiredStatusChecks | BranchProtectionV3RequiredStatusChecks | required_status_checks block. | +| requireSignedCommits | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Setting this to 'true' requires all commits to be signed with GPG. | +| restrictions | BranchProtectionV3Restrictions | restrictions block. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `branch`Required + +```java +public java.lang.String getBranch(); +``` + +- *Type:* java.lang.String + +The Git branch to protect. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#branch BranchProtectionV3#branch} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The GitHub repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#repository BranchProtectionV3#repository} + +--- + +##### `enforceAdmins`Optional + +```java +public java.lang.Boolean|IResolvable getEnforceAdmins(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Setting this to 'true' enforces status checks for repository administrators. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#enforce_admins BranchProtectionV3#enforce_admins} + +--- + +##### `id`Optional + +```java +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/resources/branch_protection_v3#id BranchProtectionV3#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. + +--- + +##### `requireConversationResolution`Optional + +```java +public java.lang.Boolean|IResolvable getRequireConversationResolution(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Setting this to 'true' requires all conversations on code must be resolved before a pull request can be merged. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#require_conversation_resolution BranchProtectionV3#require_conversation_resolution} + +--- + +##### `requiredPullRequestReviews`Optional + +```java +public BranchProtectionV3RequiredPullRequestReviews getRequiredPullRequestReviews(); +``` + +- *Type:* BranchProtectionV3RequiredPullRequestReviews + +required_pull_request_reviews block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#required_pull_request_reviews BranchProtectionV3#required_pull_request_reviews} + +--- + +##### `requiredStatusChecks`Optional + +```java +public BranchProtectionV3RequiredStatusChecks getRequiredStatusChecks(); +``` + +- *Type:* BranchProtectionV3RequiredStatusChecks + +required_status_checks block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#required_status_checks BranchProtectionV3#required_status_checks} + +--- + +##### `requireSignedCommits`Optional + +```java +public java.lang.Boolean|IResolvable getRequireSignedCommits(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Setting this to 'true' requires all commits to be signed with GPG. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#require_signed_commits BranchProtectionV3#require_signed_commits} + +--- + +##### `restrictions`Optional + +```java +public BranchProtectionV3Restrictions getRestrictions(); +``` + +- *Type:* BranchProtectionV3Restrictions + +restrictions block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#restrictions BranchProtectionV3#restrictions} + +--- + +### BranchProtectionV3RequiredPullRequestReviews + +#### Initializer + +```java +import io.cdktn.providers.github.branch_protection_v3.BranchProtectionV3RequiredPullRequestReviews; + +BranchProtectionV3RequiredPullRequestReviews.builder() +// .bypassPullRequestAllowances(BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances) +// .dismissalApps(java.util.List) +// .dismissalTeams(java.util.List) +// .dismissalUsers(java.util.List) +// .dismissStaleReviews(java.lang.Boolean|IResolvable) +// .includeAdmins(java.lang.Boolean|IResolvable) +// .requireCodeOwnerReviews(java.lang.Boolean|IResolvable) +// .requiredApprovingReviewCount(java.lang.Number) +// .requireLastPushApproval(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| bypassPullRequestAllowances | BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances | bypass_pull_request_allowances block. | +| dismissalApps | java.util.List | The list of apps slugs with dismissal access. | +| dismissalTeams | java.util.List | The list of team slugs with dismissal access. | +| dismissalUsers | java.util.List | The list of user logins with dismissal access. | +| dismissStaleReviews | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Dismiss approved reviews automatically when a new commit is pushed. | +| includeAdmins | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#include_admins BranchProtectionV3#include_admins}. | +| requireCodeOwnerReviews | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Require an approved review in pull requests including files with a designated code owner. | +| requiredApprovingReviewCount | java.lang.Number | Require 'x' number of approvals to satisfy branch protection requirements. | +| requireLastPushApproval | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Require that the most recent push must be approved by someone other than the last pusher. | + +--- + +##### `bypassPullRequestAllowances`Optional + +```java +public BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances getBypassPullRequestAllowances(); +``` + +- *Type:* BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances + +bypass_pull_request_allowances block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#bypass_pull_request_allowances BranchProtectionV3#bypass_pull_request_allowances} + +--- + +##### `dismissalApps`Optional + +```java +public java.util.List getDismissalApps(); +``` + +- *Type:* java.util.List + +The list of apps slugs with dismissal access. + +Always use slug of the app, not its name. Each app already has to have access to the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#dismissal_apps BranchProtectionV3#dismissal_apps} + +--- + +##### `dismissalTeams`Optional + +```java +public java.util.List getDismissalTeams(); +``` + +- *Type:* java.util.List + +The list of team slugs with dismissal access. + +Always use slug of the team, not its name. Each team already has to have access to the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#dismissal_teams BranchProtectionV3#dismissal_teams} + +--- + +##### `dismissalUsers`Optional + +```java +public java.util.List getDismissalUsers(); +``` + +- *Type:* java.util.List + +The list of user logins with dismissal access. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#dismissal_users BranchProtectionV3#dismissal_users} + +--- + +##### `dismissStaleReviews`Optional + +```java +public java.lang.Boolean|IResolvable getDismissStaleReviews(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Dismiss approved reviews automatically when a new commit is pushed. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#dismiss_stale_reviews BranchProtectionV3#dismiss_stale_reviews} + +--- + +##### `includeAdmins`Optional + +```java +public java.lang.Boolean|IResolvable getIncludeAdmins(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#include_admins BranchProtectionV3#include_admins}. + +--- + +##### `requireCodeOwnerReviews`Optional + +```java +public java.lang.Boolean|IResolvable getRequireCodeOwnerReviews(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Require an approved review in pull requests including files with a designated code owner. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#require_code_owner_reviews BranchProtectionV3#require_code_owner_reviews} + +--- + +##### `requiredApprovingReviewCount`Optional + +```java +public java.lang.Number getRequiredApprovingReviewCount(); +``` + +- *Type:* java.lang.Number + +Require 'x' number of approvals to satisfy branch protection requirements. + +If this is specified it must be a number between 0-6. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#required_approving_review_count BranchProtectionV3#required_approving_review_count} + +--- + +##### `requireLastPushApproval`Optional + +```java +public java.lang.Boolean|IResolvable getRequireLastPushApproval(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Require that the most recent push must be approved by someone other than the last pusher. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#require_last_push_approval BranchProtectionV3#require_last_push_approval} + +--- + +### BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances + +#### Initializer + +```java +import io.cdktn.providers.github.branch_protection_v3.BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances; + +BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances.builder() +// .apps(java.util.List) +// .teams(java.util.List) +// .users(java.util.List) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apps | java.util.List | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#apps BranchProtectionV3#apps}. | +| teams | java.util.List | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#teams BranchProtectionV3#teams}. | +| users | java.util.List | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#users BranchProtectionV3#users}. | + +--- + +##### `apps`Optional + +```java +public java.util.List getApps(); +``` + +- *Type:* java.util.List + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#apps BranchProtectionV3#apps}. + +--- + +##### `teams`Optional + +```java +public java.util.List getTeams(); +``` + +- *Type:* java.util.List + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#teams BranchProtectionV3#teams}. + +--- + +##### `users`Optional + +```java +public java.util.List getUsers(); +``` + +- *Type:* java.util.List + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#users BranchProtectionV3#users}. + +--- + +### BranchProtectionV3RequiredStatusChecks + +#### Initializer + +```java +import io.cdktn.providers.github.branch_protection_v3.BranchProtectionV3RequiredStatusChecks; + +BranchProtectionV3RequiredStatusChecks.builder() +// .checks(java.util.List) +// .contexts(java.util.List) +// .includeAdmins(java.lang.Boolean|IResolvable) +// .strict(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| checks | java.util.List | The list of status checks to require in order to merge into this branch. | +| contexts | java.util.List | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#contexts BranchProtectionV3#contexts}. | +| includeAdmins | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#include_admins BranchProtectionV3#include_admins}. | +| strict | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Require branches to be up to date before merging. | + +--- + +##### `checks`Optional + +```java +public java.util.List getChecks(); +``` + +- *Type:* java.util.List + +The list of status checks to require in order to merge into this branch. + +No status checks are required by default. Checks should be strings containing the 'context' and 'app_id' like so 'context:app_id' + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#checks BranchProtectionV3#checks} + +--- + +##### `contexts`Optional + +```java +public java.util.List getContexts(); +``` + +- *Type:* java.util.List + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#contexts BranchProtectionV3#contexts}. + +--- + +##### `includeAdmins`Optional + +```java +public java.lang.Boolean|IResolvable getIncludeAdmins(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#include_admins BranchProtectionV3#include_admins}. + +--- + +##### `strict`Optional + +```java +public java.lang.Boolean|IResolvable getStrict(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Require branches to be up to date before merging. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#strict BranchProtectionV3#strict} + +--- + +### BranchProtectionV3Restrictions + +#### Initializer + +```java +import io.cdktn.providers.github.branch_protection_v3.BranchProtectionV3Restrictions; + +BranchProtectionV3Restrictions.builder() +// .apps(java.util.List) +// .teams(java.util.List) +// .users(java.util.List) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apps | java.util.List | The list of app slugs with push access. | +| teams | java.util.List | The list of team slugs with push access. | +| users | java.util.List | The list of user logins with push access. | + +--- + +##### `apps`Optional + +```java +public java.util.List getApps(); +``` + +- *Type:* java.util.List + +The list of app slugs with push access. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#apps BranchProtectionV3#apps} + +--- + +##### `teams`Optional + +```java +public java.util.List getTeams(); +``` + +- *Type:* java.util.List + +The list of team slugs with push access. + +Always use slug of the team, not its name. Each team already has to have access to the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#teams BranchProtectionV3#teams} + +--- + +##### `users`Optional + +```java +public java.util.List getUsers(); +``` + +- *Type:* java.util.List + +The list of user logins with push access. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/branch_protection_v3#users BranchProtectionV3#users} + +--- + +## Classes + +### BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.branch_protection_v3.BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference; + +new BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetApps | *No description.* | +| resetTeams | *No description.* | +| resetUsers | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetApps` + +```java +public void resetApps() +``` + +##### `resetTeams` + +```java +public void resetTeams() +``` + +##### `resetUsers` + +```java +public void resetUsers() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| appsInput | java.util.List | *No description.* | +| teamsInput | java.util.List | *No description.* | +| usersInput | java.util.List | *No description.* | +| apps | java.util.List | *No description.* | +| teams | java.util.List | *No description.* | +| users | java.util.List | *No description.* | +| internalValue | BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `appsInput`Optional + +```java +public java.util.List getAppsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `teamsInput`Optional + +```java +public java.util.List getTeamsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `usersInput`Optional + +```java +public java.util.List getUsersInput(); +``` + +- *Type:* java.util.List + +--- + +##### `apps`Required + +```java +public java.util.List getApps(); +``` + +- *Type:* java.util.List + +--- + +##### `teams`Required + +```java +public java.util.List getTeams(); +``` + +- *Type:* java.util.List + +--- + +##### `users`Required + +```java +public java.util.List getUsers(); +``` + +- *Type:* java.util.List + +--- + +##### `internalValue`Optional + +```java +public BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances getInternalValue(); +``` + +- *Type:* BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances + +--- + + +### BranchProtectionV3RequiredPullRequestReviewsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.branch_protection_v3.BranchProtectionV3RequiredPullRequestReviewsOutputReference; + +new BranchProtectionV3RequiredPullRequestReviewsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| putBypassPullRequestAllowances | *No description.* | +| resetBypassPullRequestAllowances | *No description.* | +| resetDismissalApps | *No description.* | +| resetDismissalTeams | *No description.* | +| resetDismissalUsers | *No description.* | +| resetDismissStaleReviews | *No description.* | +| resetIncludeAdmins | *No description.* | +| resetRequireCodeOwnerReviews | *No description.* | +| resetRequiredApprovingReviewCount | *No description.* | +| resetRequireLastPushApproval | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `putBypassPullRequestAllowances` + +```java +public void putBypassPullRequestAllowances(BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances value) +``` + +###### `value`Required + +- *Type:* BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances + +--- + +##### `resetBypassPullRequestAllowances` + +```java +public void resetBypassPullRequestAllowances() +``` + +##### `resetDismissalApps` + +```java +public void resetDismissalApps() +``` + +##### `resetDismissalTeams` + +```java +public void resetDismissalTeams() +``` + +##### `resetDismissalUsers` + +```java +public void resetDismissalUsers() +``` + +##### `resetDismissStaleReviews` + +```java +public void resetDismissStaleReviews() +``` + +##### `resetIncludeAdmins` + +```java +public void resetIncludeAdmins() +``` + +##### `resetRequireCodeOwnerReviews` + +```java +public void resetRequireCodeOwnerReviews() +``` + +##### `resetRequiredApprovingReviewCount` + +```java +public void resetRequiredApprovingReviewCount() +``` + +##### `resetRequireLastPushApproval` + +```java +public void resetRequireLastPushApproval() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| bypassPullRequestAllowances | BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference | *No description.* | +| bypassPullRequestAllowancesInput | BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances | *No description.* | +| dismissalAppsInput | java.util.List | *No description.* | +| dismissalTeamsInput | java.util.List | *No description.* | +| dismissalUsersInput | java.util.List | *No description.* | +| dismissStaleReviewsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| includeAdminsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requireCodeOwnerReviewsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requiredApprovingReviewCountInput | java.lang.Number | *No description.* | +| requireLastPushApprovalInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| dismissalApps | java.util.List | *No description.* | +| dismissalTeams | java.util.List | *No description.* | +| dismissalUsers | java.util.List | *No description.* | +| dismissStaleReviews | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| includeAdmins | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requireCodeOwnerReviews | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requiredApprovingReviewCount | java.lang.Number | *No description.* | +| requireLastPushApproval | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| internalValue | BranchProtectionV3RequiredPullRequestReviews | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `bypassPullRequestAllowances`Required + +```java +public BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference getBypassPullRequestAllowances(); +``` + +- *Type:* BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference + +--- + +##### `bypassPullRequestAllowancesInput`Optional + +```java +public BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances getBypassPullRequestAllowancesInput(); +``` + +- *Type:* BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances + +--- + +##### `dismissalAppsInput`Optional + +```java +public java.util.List getDismissalAppsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `dismissalTeamsInput`Optional + +```java +public java.util.List getDismissalTeamsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `dismissalUsersInput`Optional + +```java +public java.util.List getDismissalUsersInput(); +``` + +- *Type:* java.util.List + +--- + +##### `dismissStaleReviewsInput`Optional + +```java +public java.lang.Boolean|IResolvable getDismissStaleReviewsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `includeAdminsInput`Optional + +```java +public java.lang.Boolean|IResolvable getIncludeAdminsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requireCodeOwnerReviewsInput`Optional + +```java +public java.lang.Boolean|IResolvable getRequireCodeOwnerReviewsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requiredApprovingReviewCountInput`Optional + +```java +public java.lang.Number getRequiredApprovingReviewCountInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `requireLastPushApprovalInput`Optional + +```java +public java.lang.Boolean|IResolvable getRequireLastPushApprovalInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `dismissalApps`Required + +```java +public java.util.List getDismissalApps(); +``` + +- *Type:* java.util.List + +--- + +##### `dismissalTeams`Required + +```java +public java.util.List getDismissalTeams(); +``` + +- *Type:* java.util.List + +--- + +##### `dismissalUsers`Required + +```java +public java.util.List getDismissalUsers(); +``` + +- *Type:* java.util.List + +--- + +##### `dismissStaleReviews`Required + +```java +public java.lang.Boolean|IResolvable getDismissStaleReviews(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `includeAdmins`Required + +```java +public java.lang.Boolean|IResolvable getIncludeAdmins(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requireCodeOwnerReviews`Required + +```java +public java.lang.Boolean|IResolvable getRequireCodeOwnerReviews(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requiredApprovingReviewCount`Required + +```java +public java.lang.Number getRequiredApprovingReviewCount(); +``` + +- *Type:* java.lang.Number + +--- + +##### `requireLastPushApproval`Required + +```java +public java.lang.Boolean|IResolvable getRequireLastPushApproval(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `internalValue`Optional + +```java +public BranchProtectionV3RequiredPullRequestReviews getInternalValue(); +``` + +- *Type:* BranchProtectionV3RequiredPullRequestReviews + +--- + + +### BranchProtectionV3RequiredStatusChecksOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.branch_protection_v3.BranchProtectionV3RequiredStatusChecksOutputReference; + +new BranchProtectionV3RequiredStatusChecksOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetChecks | *No description.* | +| resetContexts | *No description.* | +| resetIncludeAdmins | *No description.* | +| resetStrict | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetChecks` + +```java +public void resetChecks() +``` + +##### `resetContexts` + +```java +public void resetContexts() +``` + +##### `resetIncludeAdmins` + +```java +public void resetIncludeAdmins() +``` + +##### `resetStrict` + +```java +public void resetStrict() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| checksInput | java.util.List | *No description.* | +| contextsInput | java.util.List | *No description.* | +| includeAdminsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| strictInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| checks | java.util.List | *No description.* | +| contexts | java.util.List | *No description.* | +| includeAdmins | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| strict | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| internalValue | BranchProtectionV3RequiredStatusChecks | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `checksInput`Optional + +```java +public java.util.List getChecksInput(); +``` + +- *Type:* java.util.List + +--- + +##### `contextsInput`Optional + +```java +public java.util.List getContextsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `includeAdminsInput`Optional + +```java +public java.lang.Boolean|IResolvable getIncludeAdminsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `strictInput`Optional + +```java +public java.lang.Boolean|IResolvable getStrictInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `checks`Required + +```java +public java.util.List getChecks(); +``` + +- *Type:* java.util.List + +--- + +##### `contexts`Required + +```java +public java.util.List getContexts(); +``` + +- *Type:* java.util.List + +--- + +##### `includeAdmins`Required + +```java +public java.lang.Boolean|IResolvable getIncludeAdmins(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `strict`Required + +```java +public java.lang.Boolean|IResolvable getStrict(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `internalValue`Optional + +```java +public BranchProtectionV3RequiredStatusChecks getInternalValue(); +``` + +- *Type:* BranchProtectionV3RequiredStatusChecks + +--- + + +### BranchProtectionV3RestrictionsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.branch_protection_v3.BranchProtectionV3RestrictionsOutputReference; + +new BranchProtectionV3RestrictionsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetApps | *No description.* | +| resetTeams | *No description.* | +| resetUsers | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetApps` + +```java +public void resetApps() +``` + +##### `resetTeams` + +```java +public void resetTeams() +``` + +##### `resetUsers` + +```java +public void resetUsers() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| appsInput | java.util.List | *No description.* | +| teamsInput | java.util.List | *No description.* | +| usersInput | java.util.List | *No description.* | +| apps | java.util.List | *No description.* | +| teams | java.util.List | *No description.* | +| users | java.util.List | *No description.* | +| internalValue | BranchProtectionV3Restrictions | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `appsInput`Optional + +```java +public java.util.List getAppsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `teamsInput`Optional + +```java +public java.util.List getTeamsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `usersInput`Optional + +```java +public java.util.List getUsersInput(); +``` + +- *Type:* java.util.List + +--- + +##### `apps`Required + +```java +public java.util.List getApps(); +``` + +- *Type:* java.util.List + +--- + +##### `teams`Required + +```java +public java.util.List getTeams(); +``` + +- *Type:* java.util.List + +--- + +##### `users`Required + +```java +public java.util.List getUsers(); +``` + +- *Type:* java.util.List + +--- + +##### `internalValue`Optional + +```java +public BranchProtectionV3Restrictions getInternalValue(); +``` + +- *Type:* BranchProtectionV3Restrictions + +--- + + + diff --git a/docs/codespacesOrganizationSecret.csharp.md b/docs/codespacesOrganizationSecret.csharp.md new file mode 100644 index 000000000..9ec647a7c --- /dev/null +++ b/docs/codespacesOrganizationSecret.csharp.md @@ -0,0 +1,1071 @@ +# `codespacesOrganizationSecret` Submodule + +## Constructs + +### CodespacesOrganizationSecret + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret github_codespaces_organization_secret}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new CodespacesOrganizationSecret(Construct Scope, string Id, CodespacesOrganizationSecretConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | CodespacesOrganizationSecretConfig | *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:* CodespacesOrganizationSecretConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetEncryptedValue | *No description.* | +| ResetId | *No description.* | +| ResetPlaintextValue | *No description.* | +| ResetSelectedRepositoryIds | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetEncryptedValue` + +```csharp +private void ResetEncryptedValue() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetPlaintextValue` + +```csharp +private void ResetPlaintextValue() +``` + +##### `ResetSelectedRepositoryIds` + +```csharp +private void ResetSelectedRepositoryIds() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a CodespacesOrganizationSecret resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +CodespacesOrganizationSecret.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` + +```csharp +using Io.Cdktn.Providers.Github; + +CodespacesOrganizationSecret.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +CodespacesOrganizationSecret.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +CodespacesOrganizationSecret.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a CodespacesOrganizationSecret resource upon running "cdktn 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 CodespacesOrganizationSecret to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing CodespacesOrganizationSecret that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the CodespacesOrganizationSecret to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| CreatedAt | string | *No description.* | +| UpdatedAt | string | *No description.* | +| EncryptedValueInput | string | *No description.* | +| IdInput | string | *No description.* | +| PlaintextValueInput | string | *No description.* | +| SecretNameInput | string | *No description.* | +| SelectedRepositoryIdsInput | double[] | *No description.* | +| VisibilityInput | string | *No description.* | +| EncryptedValue | string | *No description.* | +| Id | string | *No description.* | +| PlaintextValue | string | *No description.* | +| SecretName | string | *No description.* | +| SelectedRepositoryIds | double[] | *No description.* | +| Visibility | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `EncryptedValueInput`Optional + +```csharp +public string EncryptedValueInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `PlaintextValueInput`Optional + +```csharp +public string PlaintextValueInput { get; } +``` + +- *Type:* string + +--- + +##### `SecretNameInput`Optional + +```csharp +public string SecretNameInput { get; } +``` + +- *Type:* string + +--- + +##### `SelectedRepositoryIdsInput`Optional + +```csharp +public double[] SelectedRepositoryIdsInput { get; } +``` + +- *Type:* double[] + +--- + +##### `VisibilityInput`Optional + +```csharp +public string VisibilityInput { get; } +``` + +- *Type:* string + +--- + +##### `EncryptedValue`Required + +```csharp +public string EncryptedValue { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `PlaintextValue`Required + +```csharp +public string PlaintextValue { get; } +``` + +- *Type:* string + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; } +``` + +- *Type:* string + +--- + +##### `SelectedRepositoryIds`Required + +```csharp +public double[] SelectedRepositoryIds { get; } +``` + +- *Type:* double[] + +--- + +##### `Visibility`Required + +```csharp +public string Visibility { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### CodespacesOrganizationSecretConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new CodespacesOrganizationSecretConfig { + 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 SecretName, + string Visibility, + string EncryptedValue = null, + string Id = null, + string PlaintextValue = null, + double[] SelectedRepositoryIds = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| SecretName | string | Name of the secret. | +| Visibility | string | Configures the access that repositories have to the organization secret. | +| EncryptedValue | string | Encrypted value of the secret using the GitHub public key in Base64 format. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret#id CodespacesOrganizationSecret#id}. | +| PlaintextValue | string | Plaintext value of the secret to be encrypted. | +| SelectedRepositoryIds | double[] | An array of repository ids that can access the organization secret. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; set; } +``` + +- *Type:* string + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret#secret_name CodespacesOrganizationSecret#secret_name} + +--- + +##### `Visibility`Required + +```csharp +public string Visibility { get; set; } +``` + +- *Type:* string + +Configures the access that repositories have to the organization secret. + +Must be one of 'all', 'private' or 'selected'. 'selected_repository_ids' is required if set to 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret#visibility CodespacesOrganizationSecret#visibility} + +--- + +##### `EncryptedValue`Optional + +```csharp +public string EncryptedValue { get; set; } +``` + +- *Type:* string + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret#encrypted_value CodespacesOrganizationSecret#encrypted_value} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret#id CodespacesOrganizationSecret#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. + +--- + +##### `PlaintextValue`Optional + +```csharp +public string PlaintextValue { get; set; } +``` + +- *Type:* string + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret#plaintext_value CodespacesOrganizationSecret#plaintext_value} + +--- + +##### `SelectedRepositoryIds`Optional + +```csharp +public double[] SelectedRepositoryIds { get; set; } +``` + +- *Type:* double[] + +An array of repository ids that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret#selected_repository_ids CodespacesOrganizationSecret#selected_repository_ids} + +--- + + + diff --git a/docs/codespacesOrganizationSecret.java.md b/docs/codespacesOrganizationSecret.java.md new file mode 100644 index 000000000..29fc7f4a7 --- /dev/null +++ b/docs/codespacesOrganizationSecret.java.md @@ -0,0 +1,1198 @@ +# `codespacesOrganizationSecret` Submodule + +## Constructs + +### CodespacesOrganizationSecret + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret github_codespaces_organization_secret}. + +#### Initializers + +```java +import io.cdktn.providers.github.codespaces_organization_secret.CodespacesOrganizationSecret; + +CodespacesOrganizationSecret.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .secretName(java.lang.String) + .visibility(java.lang.String) +// .encryptedValue(java.lang.String) +// .id(java.lang.String) +// .plaintextValue(java.lang.String) +// .selectedRepositoryIds(java.util.List) + .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 | *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 | *No description.* | +| secretName | java.lang.String | Name of the secret. | +| visibility | java.lang.String | Configures the access that repositories have to the organization secret. | +| encryptedValue | java.lang.String | Encrypted value of the secret using the GitHub public key in Base64 format. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret#id CodespacesOrganizationSecret#id}. | +| plaintextValue | java.lang.String | Plaintext value of the secret to be encrypted. | +| selectedRepositoryIds | java.util.List | An array of repository ids that can access the organization secret. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `secretName`Required + +- *Type:* java.lang.String + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret#secret_name CodespacesOrganizationSecret#secret_name} + +--- + +##### `visibility`Required + +- *Type:* java.lang.String + +Configures the access that repositories have to the organization secret. + +Must be one of 'all', 'private' or 'selected'. 'selected_repository_ids' is required if set to 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret#visibility CodespacesOrganizationSecret#visibility} + +--- + +##### `encryptedValue`Optional + +- *Type:* java.lang.String + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret#encrypted_value CodespacesOrganizationSecret#encrypted_value} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret#id CodespacesOrganizationSecret#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. + +--- + +##### `plaintextValue`Optional + +- *Type:* java.lang.String + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret#plaintext_value CodespacesOrganizationSecret#plaintext_value} + +--- + +##### `selectedRepositoryIds`Optional + +- *Type:* java.util.List + +An array of repository ids that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret#selected_repository_ids CodespacesOrganizationSecret#selected_repository_ids} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetEncryptedValue | *No description.* | +| resetId | *No description.* | +| resetPlaintextValue | *No description.* | +| resetSelectedRepositoryIds | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetEncryptedValue` + +```java +public void resetEncryptedValue() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetPlaintextValue` + +```java +public void resetPlaintextValue() +``` + +##### `resetSelectedRepositoryIds` + +```java +public void resetSelectedRepositoryIds() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a CodespacesOrganizationSecret resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.codespaces_organization_secret.CodespacesOrganizationSecret; + +CodespacesOrganizationSecret.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` + +```java +import io.cdktn.providers.github.codespaces_organization_secret.CodespacesOrganizationSecret; + +CodespacesOrganizationSecret.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.codespaces_organization_secret.CodespacesOrganizationSecret; + +CodespacesOrganizationSecret.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.codespaces_organization_secret.CodespacesOrganizationSecret; + +CodespacesOrganizationSecret.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),CodespacesOrganizationSecret.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a CodespacesOrganizationSecret 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 CodespacesOrganizationSecret to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing CodespacesOrganizationSecret that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret#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 CodespacesOrganizationSecret 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| createdAt | java.lang.String | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| encryptedValueInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| plaintextValueInput | java.lang.String | *No description.* | +| secretNameInput | java.lang.String | *No description.* | +| selectedRepositoryIdsInput | java.util.List | *No description.* | +| visibilityInput | java.lang.String | *No description.* | +| encryptedValue | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| plaintextValue | java.lang.String | *No description.* | +| secretName | java.lang.String | *No description.* | +| selectedRepositoryIds | java.util.List | *No description.* | +| visibility | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `encryptedValueInput`Optional + +```java +public java.lang.String getEncryptedValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `plaintextValueInput`Optional + +```java +public java.lang.String getPlaintextValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretNameInput`Optional + +```java +public java.lang.String getSecretNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `selectedRepositoryIdsInput`Optional + +```java +public java.util.List getSelectedRepositoryIdsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `visibilityInput`Optional + +```java +public java.lang.String getVisibilityInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `encryptedValue`Required + +```java +public java.lang.String getEncryptedValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `plaintextValue`Required + +```java +public java.lang.String getPlaintextValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +--- + +##### `selectedRepositoryIds`Required + +```java +public java.util.List getSelectedRepositoryIds(); +``` + +- *Type:* java.util.List + +--- + +##### `visibility`Required + +```java +public java.lang.String getVisibility(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### CodespacesOrganizationSecretConfig + +#### Initializer + +```java +import io.cdktn.providers.github.codespaces_organization_secret.CodespacesOrganizationSecretConfig; + +CodespacesOrganizationSecretConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .secretName(java.lang.String) + .visibility(java.lang.String) +// .encryptedValue(java.lang.String) +// .id(java.lang.String) +// .plaintextValue(java.lang.String) +// .selectedRepositoryIds(java.util.List) + .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 | *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 | *No description.* | +| secretName | java.lang.String | Name of the secret. | +| visibility | java.lang.String | Configures the access that repositories have to the organization secret. | +| encryptedValue | java.lang.String | Encrypted value of the secret using the GitHub public key in Base64 format. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret#id CodespacesOrganizationSecret#id}. | +| plaintextValue | java.lang.String | Plaintext value of the secret to be encrypted. | +| selectedRepositoryIds | java.util.List | An array of repository ids that can access the organization secret. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret#secret_name CodespacesOrganizationSecret#secret_name} + +--- + +##### `visibility`Required + +```java +public java.lang.String getVisibility(); +``` + +- *Type:* java.lang.String + +Configures the access that repositories have to the organization secret. + +Must be one of 'all', 'private' or 'selected'. 'selected_repository_ids' is required if set to 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret#visibility CodespacesOrganizationSecret#visibility} + +--- + +##### `encryptedValue`Optional + +```java +public java.lang.String getEncryptedValue(); +``` + +- *Type:* java.lang.String + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret#encrypted_value CodespacesOrganizationSecret#encrypted_value} + +--- + +##### `id`Optional + +```java +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/resources/codespaces_organization_secret#id CodespacesOrganizationSecret#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. + +--- + +##### `plaintextValue`Optional + +```java +public java.lang.String getPlaintextValue(); +``` + +- *Type:* java.lang.String + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret#plaintext_value CodespacesOrganizationSecret#plaintext_value} + +--- + +##### `selectedRepositoryIds`Optional + +```java +public java.util.List getSelectedRepositoryIds(); +``` + +- *Type:* java.util.List + +An array of repository ids that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret#selected_repository_ids CodespacesOrganizationSecret#selected_repository_ids} + +--- + + + diff --git a/docs/codespacesOrganizationSecretRepositories.csharp.md b/docs/codespacesOrganizationSecretRepositories.csharp.md new file mode 100644 index 000000000..a63c9ef04 --- /dev/null +++ b/docs/codespacesOrganizationSecretRepositories.csharp.md @@ -0,0 +1,912 @@ +# `codespacesOrganizationSecretRepositories` Submodule + +## Constructs + +### CodespacesOrganizationSecretRepositories + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret_repositories github_codespaces_organization_secret_repositories}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new CodespacesOrganizationSecretRepositories(Construct Scope, string Id, CodespacesOrganizationSecretRepositoriesConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | CodespacesOrganizationSecretRepositoriesConfig | *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:* CodespacesOrganizationSecretRepositoriesConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a CodespacesOrganizationSecretRepositories resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +CodespacesOrganizationSecretRepositories.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` + +```csharp +using Io.Cdktn.Providers.Github; + +CodespacesOrganizationSecretRepositories.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +CodespacesOrganizationSecretRepositories.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +CodespacesOrganizationSecretRepositories.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a CodespacesOrganizationSecretRepositories resource upon running "cdktn 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 CodespacesOrganizationSecretRepositories to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing CodespacesOrganizationSecretRepositories that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret_repositories#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the CodespacesOrganizationSecretRepositories to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| IdInput | string | *No description.* | +| SecretNameInput | string | *No description.* | +| SelectedRepositoryIdsInput | double[] | *No description.* | +| Id | string | *No description.* | +| SecretName | string | *No description.* | +| SelectedRepositoryIds | double[] | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `SecretNameInput`Optional + +```csharp +public string SecretNameInput { get; } +``` + +- *Type:* string + +--- + +##### `SelectedRepositoryIdsInput`Optional + +```csharp +public double[] SelectedRepositoryIdsInput { get; } +``` + +- *Type:* double[] + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; } +``` + +- *Type:* string + +--- + +##### `SelectedRepositoryIds`Required + +```csharp +public double[] SelectedRepositoryIds { get; } +``` + +- *Type:* double[] + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### CodespacesOrganizationSecretRepositoriesConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new CodespacesOrganizationSecretRepositoriesConfig { + 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 SecretName, + double[] SelectedRepositoryIds, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| SecretName | string | Name of the existing secret. | +| SelectedRepositoryIds | double[] | An array of repository ids that can access the organization secret. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret_repositories#id CodespacesOrganizationSecretRepositories#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; set; } +``` + +- *Type:* string + +Name of the existing secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret_repositories#secret_name CodespacesOrganizationSecretRepositories#secret_name} + +--- + +##### `SelectedRepositoryIds`Required + +```csharp +public double[] SelectedRepositoryIds { get; set; } +``` + +- *Type:* double[] + +An array of repository ids that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret_repositories#selected_repository_ids CodespacesOrganizationSecretRepositories#selected_repository_ids} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret_repositories#id CodespacesOrganizationSecretRepositories#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. + +--- + + + diff --git a/docs/codespacesOrganizationSecretRepositories.java.md b/docs/codespacesOrganizationSecretRepositories.java.md new file mode 100644 index 000000000..853eda8ba --- /dev/null +++ b/docs/codespacesOrganizationSecretRepositories.java.md @@ -0,0 +1,1001 @@ +# `codespacesOrganizationSecretRepositories` Submodule + +## Constructs + +### CodespacesOrganizationSecretRepositories + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret_repositories github_codespaces_organization_secret_repositories}. + +#### Initializers + +```java +import io.cdktn.providers.github.codespaces_organization_secret_repositories.CodespacesOrganizationSecretRepositories; + +CodespacesOrganizationSecretRepositories.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .secretName(java.lang.String) + .selectedRepositoryIds(java.util.List) +// .id(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 | *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 | *No description.* | +| secretName | java.lang.String | Name of the existing secret. | +| selectedRepositoryIds | java.util.List | An array of repository ids that can access the organization secret. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret_repositories#id CodespacesOrganizationSecretRepositories#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `secretName`Required + +- *Type:* java.lang.String + +Name of the existing secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret_repositories#secret_name CodespacesOrganizationSecretRepositories#secret_name} + +--- + +##### `selectedRepositoryIds`Required + +- *Type:* java.util.List + +An array of repository ids that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret_repositories#selected_repository_ids CodespacesOrganizationSecretRepositories#selected_repository_ids} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret_repositories#id CodespacesOrganizationSecretRepositories#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a CodespacesOrganizationSecretRepositories resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.codespaces_organization_secret_repositories.CodespacesOrganizationSecretRepositories; + +CodespacesOrganizationSecretRepositories.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` + +```java +import io.cdktn.providers.github.codespaces_organization_secret_repositories.CodespacesOrganizationSecretRepositories; + +CodespacesOrganizationSecretRepositories.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.codespaces_organization_secret_repositories.CodespacesOrganizationSecretRepositories; + +CodespacesOrganizationSecretRepositories.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.codespaces_organization_secret_repositories.CodespacesOrganizationSecretRepositories; + +CodespacesOrganizationSecretRepositories.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),CodespacesOrganizationSecretRepositories.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a CodespacesOrganizationSecretRepositories 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 CodespacesOrganizationSecretRepositories to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing CodespacesOrganizationSecretRepositories that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret_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 CodespacesOrganizationSecretRepositories 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| idInput | java.lang.String | *No description.* | +| secretNameInput | java.lang.String | *No description.* | +| selectedRepositoryIdsInput | java.util.List | *No description.* | +| id | java.lang.String | *No description.* | +| secretName | java.lang.String | *No description.* | +| selectedRepositoryIds | java.util.List | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretNameInput`Optional + +```java +public java.lang.String getSecretNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `selectedRepositoryIdsInput`Optional + +```java +public java.util.List getSelectedRepositoryIdsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +--- + +##### `selectedRepositoryIds`Required + +```java +public java.util.List getSelectedRepositoryIds(); +``` + +- *Type:* java.util.List + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### CodespacesOrganizationSecretRepositoriesConfig + +#### Initializer + +```java +import io.cdktn.providers.github.codespaces_organization_secret_repositories.CodespacesOrganizationSecretRepositoriesConfig; + +CodespacesOrganizationSecretRepositoriesConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .secretName(java.lang.String) + .selectedRepositoryIds(java.util.List) +// .id(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 | *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 | *No description.* | +| secretName | java.lang.String | Name of the existing secret. | +| selectedRepositoryIds | java.util.List | An array of repository ids that can access the organization secret. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret_repositories#id CodespacesOrganizationSecretRepositories#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +Name of the existing secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret_repositories#secret_name CodespacesOrganizationSecretRepositories#secret_name} + +--- + +##### `selectedRepositoryIds`Required + +```java +public java.util.List getSelectedRepositoryIds(); +``` + +- *Type:* java.util.List + +An array of repository ids that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_organization_secret_repositories#selected_repository_ids CodespacesOrganizationSecretRepositories#selected_repository_ids} + +--- + +##### `id`Optional + +```java +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/resources/codespaces_organization_secret_repositories#id CodespacesOrganizationSecretRepositories#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. + +--- + + + diff --git a/docs/codespacesSecret.csharp.md b/docs/codespacesSecret.csharp.md new file mode 100644 index 000000000..a0bc0c083 --- /dev/null +++ b/docs/codespacesSecret.csharp.md @@ -0,0 +1,1024 @@ +# `codespacesSecret` Submodule + +## Constructs + +### CodespacesSecret + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_secret github_codespaces_secret}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new CodespacesSecret(Construct Scope, string Id, CodespacesSecretConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | CodespacesSecretConfig | *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:* CodespacesSecretConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetEncryptedValue | *No description.* | +| ResetId | *No description.* | +| ResetPlaintextValue | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetEncryptedValue` + +```csharp +private void ResetEncryptedValue() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetPlaintextValue` + +```csharp +private void ResetPlaintextValue() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a CodespacesSecret resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +CodespacesSecret.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` + +```csharp +using Io.Cdktn.Providers.Github; + +CodespacesSecret.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +CodespacesSecret.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +CodespacesSecret.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a CodespacesSecret resource upon running "cdktn 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 CodespacesSecret to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing CodespacesSecret that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_secret#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the CodespacesSecret to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| CreatedAt | string | *No description.* | +| UpdatedAt | string | *No description.* | +| EncryptedValueInput | string | *No description.* | +| IdInput | string | *No description.* | +| PlaintextValueInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| SecretNameInput | string | *No description.* | +| EncryptedValue | string | *No description.* | +| Id | string | *No description.* | +| PlaintextValue | string | *No description.* | +| Repository | string | *No description.* | +| SecretName | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `EncryptedValueInput`Optional + +```csharp +public string EncryptedValueInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `PlaintextValueInput`Optional + +```csharp +public string PlaintextValueInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `SecretNameInput`Optional + +```csharp +public string SecretNameInput { get; } +``` + +- *Type:* string + +--- + +##### `EncryptedValue`Required + +```csharp +public string EncryptedValue { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `PlaintextValue`Required + +```csharp +public string PlaintextValue { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### CodespacesSecretConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new CodespacesSecretConfig { + 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 Repository, + string SecretName, + string EncryptedValue = null, + string Id = null, + string PlaintextValue = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | Name of the repository. | +| SecretName | string | Name of the secret. | +| EncryptedValue | string | Encrypted value of the secret using the GitHub public key in Base64 format. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_secret#id CodespacesSecret#id}. | +| PlaintextValue | string | Plaintext value of the secret to be encrypted. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_secret#repository CodespacesSecret#repository} + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; set; } +``` + +- *Type:* string + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_secret#secret_name CodespacesSecret#secret_name} + +--- + +##### `EncryptedValue`Optional + +```csharp +public string EncryptedValue { get; set; } +``` + +- *Type:* string + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_secret#encrypted_value CodespacesSecret#encrypted_value} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_secret#id CodespacesSecret#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. + +--- + +##### `PlaintextValue`Optional + +```csharp +public string PlaintextValue { get; set; } +``` + +- *Type:* string + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_secret#plaintext_value CodespacesSecret#plaintext_value} + +--- + + + diff --git a/docs/codespacesSecret.java.md b/docs/codespacesSecret.java.md new file mode 100644 index 000000000..87851b994 --- /dev/null +++ b/docs/codespacesSecret.java.md @@ -0,0 +1,1137 @@ +# `codespacesSecret` Submodule + +## Constructs + +### CodespacesSecret + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_secret github_codespaces_secret}. + +#### Initializers + +```java +import io.cdktn.providers.github.codespaces_secret.CodespacesSecret; + +CodespacesSecret.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) + .secretName(java.lang.String) +// .encryptedValue(java.lang.String) +// .id(java.lang.String) +// .plaintextValue(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 | *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 | *No description.* | +| repository | java.lang.String | Name of the repository. | +| secretName | java.lang.String | Name of the secret. | +| encryptedValue | java.lang.String | Encrypted value of the secret using the GitHub public key in Base64 format. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_secret#id CodespacesSecret#id}. | +| plaintextValue | java.lang.String | Plaintext value of the secret to be encrypted. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_secret#repository CodespacesSecret#repository} + +--- + +##### `secretName`Required + +- *Type:* java.lang.String + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_secret#secret_name CodespacesSecret#secret_name} + +--- + +##### `encryptedValue`Optional + +- *Type:* java.lang.String + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_secret#encrypted_value CodespacesSecret#encrypted_value} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_secret#id CodespacesSecret#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. + +--- + +##### `plaintextValue`Optional + +- *Type:* java.lang.String + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_secret#plaintext_value CodespacesSecret#plaintext_value} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetEncryptedValue | *No description.* | +| resetId | *No description.* | +| resetPlaintextValue | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetEncryptedValue` + +```java +public void resetEncryptedValue() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetPlaintextValue` + +```java +public void resetPlaintextValue() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a CodespacesSecret resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.codespaces_secret.CodespacesSecret; + +CodespacesSecret.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` + +```java +import io.cdktn.providers.github.codespaces_secret.CodespacesSecret; + +CodespacesSecret.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.codespaces_secret.CodespacesSecret; + +CodespacesSecret.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.codespaces_secret.CodespacesSecret; + +CodespacesSecret.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),CodespacesSecret.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a CodespacesSecret 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 CodespacesSecret to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing CodespacesSecret that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_secret#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 CodespacesSecret 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| createdAt | java.lang.String | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| encryptedValueInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| plaintextValueInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| secretNameInput | java.lang.String | *No description.* | +| encryptedValue | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| plaintextValue | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | +| secretName | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `encryptedValueInput`Optional + +```java +public java.lang.String getEncryptedValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `plaintextValueInput`Optional + +```java +public java.lang.String getPlaintextValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretNameInput`Optional + +```java +public java.lang.String getSecretNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `encryptedValue`Required + +```java +public java.lang.String getEncryptedValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `plaintextValue`Required + +```java +public java.lang.String getPlaintextValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### CodespacesSecretConfig + +#### Initializer + +```java +import io.cdktn.providers.github.codespaces_secret.CodespacesSecretConfig; + +CodespacesSecretConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) + .secretName(java.lang.String) +// .encryptedValue(java.lang.String) +// .id(java.lang.String) +// .plaintextValue(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 | *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 | *No description.* | +| repository | java.lang.String | Name of the repository. | +| secretName | java.lang.String | Name of the secret. | +| encryptedValue | java.lang.String | Encrypted value of the secret using the GitHub public key in Base64 format. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_secret#id CodespacesSecret#id}. | +| plaintextValue | java.lang.String | Plaintext value of the secret to be encrypted. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_secret#repository CodespacesSecret#repository} + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_secret#secret_name CodespacesSecret#secret_name} + +--- + +##### `encryptedValue`Optional + +```java +public java.lang.String getEncryptedValue(); +``` + +- *Type:* java.lang.String + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_secret#encrypted_value CodespacesSecret#encrypted_value} + +--- + +##### `id`Optional + +```java +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/resources/codespaces_secret#id CodespacesSecret#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. + +--- + +##### `plaintextValue`Optional + +```java +public java.lang.String getPlaintextValue(); +``` + +- *Type:* java.lang.String + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_secret#plaintext_value CodespacesSecret#plaintext_value} + +--- + + + diff --git a/docs/codespacesUserSecret.csharp.md b/docs/codespacesUserSecret.csharp.md new file mode 100644 index 000000000..4154fe706 --- /dev/null +++ b/docs/codespacesUserSecret.csharp.md @@ -0,0 +1,1031 @@ +# `codespacesUserSecret` Submodule + +## Constructs + +### CodespacesUserSecret + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_user_secret github_codespaces_user_secret}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new CodespacesUserSecret(Construct Scope, string Id, CodespacesUserSecretConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | CodespacesUserSecretConfig | *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:* CodespacesUserSecretConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetEncryptedValue | *No description.* | +| ResetId | *No description.* | +| ResetPlaintextValue | *No description.* | +| ResetSelectedRepositoryIds | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetEncryptedValue` + +```csharp +private void ResetEncryptedValue() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetPlaintextValue` + +```csharp +private void ResetPlaintextValue() +``` + +##### `ResetSelectedRepositoryIds` + +```csharp +private void ResetSelectedRepositoryIds() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a CodespacesUserSecret resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +CodespacesUserSecret.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` + +```csharp +using Io.Cdktn.Providers.Github; + +CodespacesUserSecret.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +CodespacesUserSecret.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +CodespacesUserSecret.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a CodespacesUserSecret resource upon running "cdktn 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 CodespacesUserSecret to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing CodespacesUserSecret that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_user_secret#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the CodespacesUserSecret to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| CreatedAt | string | *No description.* | +| UpdatedAt | string | *No description.* | +| EncryptedValueInput | string | *No description.* | +| IdInput | string | *No description.* | +| PlaintextValueInput | string | *No description.* | +| SecretNameInput | string | *No description.* | +| SelectedRepositoryIdsInput | double[] | *No description.* | +| EncryptedValue | string | *No description.* | +| Id | string | *No description.* | +| PlaintextValue | string | *No description.* | +| SecretName | string | *No description.* | +| SelectedRepositoryIds | double[] | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `EncryptedValueInput`Optional + +```csharp +public string EncryptedValueInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `PlaintextValueInput`Optional + +```csharp +public string PlaintextValueInput { get; } +``` + +- *Type:* string + +--- + +##### `SecretNameInput`Optional + +```csharp +public string SecretNameInput { get; } +``` + +- *Type:* string + +--- + +##### `SelectedRepositoryIdsInput`Optional + +```csharp +public double[] SelectedRepositoryIdsInput { get; } +``` + +- *Type:* double[] + +--- + +##### `EncryptedValue`Required + +```csharp +public string EncryptedValue { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `PlaintextValue`Required + +```csharp +public string PlaintextValue { get; } +``` + +- *Type:* string + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; } +``` + +- *Type:* string + +--- + +##### `SelectedRepositoryIds`Required + +```csharp +public double[] SelectedRepositoryIds { get; } +``` + +- *Type:* double[] + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### CodespacesUserSecretConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new CodespacesUserSecretConfig { + 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 SecretName, + string EncryptedValue = null, + string Id = null, + string PlaintextValue = null, + double[] SelectedRepositoryIds = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| SecretName | string | Name of the secret. | +| EncryptedValue | string | Encrypted value of the secret using the GitHub public key in Base64 format. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_user_secret#id CodespacesUserSecret#id}. | +| PlaintextValue | string | Plaintext value of the secret to be encrypted. | +| SelectedRepositoryIds | double[] | An array of repository ids that can access the user secret. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; set; } +``` + +- *Type:* string + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_user_secret#secret_name CodespacesUserSecret#secret_name} + +--- + +##### `EncryptedValue`Optional + +```csharp +public string EncryptedValue { get; set; } +``` + +- *Type:* string + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_user_secret#encrypted_value CodespacesUserSecret#encrypted_value} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_user_secret#id CodespacesUserSecret#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. + +--- + +##### `PlaintextValue`Optional + +```csharp +public string PlaintextValue { get; set; } +``` + +- *Type:* string + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_user_secret#plaintext_value CodespacesUserSecret#plaintext_value} + +--- + +##### `SelectedRepositoryIds`Optional + +```csharp +public double[] SelectedRepositoryIds { get; set; } +``` + +- *Type:* double[] + +An array of repository ids that can access the user secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_user_secret#selected_repository_ids CodespacesUserSecret#selected_repository_ids} + +--- + + + diff --git a/docs/codespacesUserSecret.java.md b/docs/codespacesUserSecret.java.md new file mode 100644 index 000000000..8403aa443 --- /dev/null +++ b/docs/codespacesUserSecret.java.md @@ -0,0 +1,1144 @@ +# `codespacesUserSecret` Submodule + +## Constructs + +### CodespacesUserSecret + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_user_secret github_codespaces_user_secret}. + +#### Initializers + +```java +import io.cdktn.providers.github.codespaces_user_secret.CodespacesUserSecret; + +CodespacesUserSecret.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .secretName(java.lang.String) +// .encryptedValue(java.lang.String) +// .id(java.lang.String) +// .plaintextValue(java.lang.String) +// .selectedRepositoryIds(java.util.List) + .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 | *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 | *No description.* | +| secretName | java.lang.String | Name of the secret. | +| encryptedValue | java.lang.String | Encrypted value of the secret using the GitHub public key in Base64 format. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_user_secret#id CodespacesUserSecret#id}. | +| plaintextValue | java.lang.String | Plaintext value of the secret to be encrypted. | +| selectedRepositoryIds | java.util.List | An array of repository ids that can access the user secret. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `secretName`Required + +- *Type:* java.lang.String + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_user_secret#secret_name CodespacesUserSecret#secret_name} + +--- + +##### `encryptedValue`Optional + +- *Type:* java.lang.String + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_user_secret#encrypted_value CodespacesUserSecret#encrypted_value} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_user_secret#id CodespacesUserSecret#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. + +--- + +##### `plaintextValue`Optional + +- *Type:* java.lang.String + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_user_secret#plaintext_value CodespacesUserSecret#plaintext_value} + +--- + +##### `selectedRepositoryIds`Optional + +- *Type:* java.util.List + +An array of repository ids that can access the user secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_user_secret#selected_repository_ids CodespacesUserSecret#selected_repository_ids} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetEncryptedValue | *No description.* | +| resetId | *No description.* | +| resetPlaintextValue | *No description.* | +| resetSelectedRepositoryIds | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetEncryptedValue` + +```java +public void resetEncryptedValue() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetPlaintextValue` + +```java +public void resetPlaintextValue() +``` + +##### `resetSelectedRepositoryIds` + +```java +public void resetSelectedRepositoryIds() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a CodespacesUserSecret resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.codespaces_user_secret.CodespacesUserSecret; + +CodespacesUserSecret.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` + +```java +import io.cdktn.providers.github.codespaces_user_secret.CodespacesUserSecret; + +CodespacesUserSecret.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.codespaces_user_secret.CodespacesUserSecret; + +CodespacesUserSecret.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.codespaces_user_secret.CodespacesUserSecret; + +CodespacesUserSecret.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),CodespacesUserSecret.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a CodespacesUserSecret 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 CodespacesUserSecret to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing CodespacesUserSecret that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_user_secret#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 CodespacesUserSecret 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| createdAt | java.lang.String | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| encryptedValueInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| plaintextValueInput | java.lang.String | *No description.* | +| secretNameInput | java.lang.String | *No description.* | +| selectedRepositoryIdsInput | java.util.List | *No description.* | +| encryptedValue | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| plaintextValue | java.lang.String | *No description.* | +| secretName | java.lang.String | *No description.* | +| selectedRepositoryIds | java.util.List | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `encryptedValueInput`Optional + +```java +public java.lang.String getEncryptedValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `plaintextValueInput`Optional + +```java +public java.lang.String getPlaintextValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretNameInput`Optional + +```java +public java.lang.String getSecretNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `selectedRepositoryIdsInput`Optional + +```java +public java.util.List getSelectedRepositoryIdsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `encryptedValue`Required + +```java +public java.lang.String getEncryptedValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `plaintextValue`Required + +```java +public java.lang.String getPlaintextValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +--- + +##### `selectedRepositoryIds`Required + +```java +public java.util.List getSelectedRepositoryIds(); +``` + +- *Type:* java.util.List + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### CodespacesUserSecretConfig + +#### Initializer + +```java +import io.cdktn.providers.github.codespaces_user_secret.CodespacesUserSecretConfig; + +CodespacesUserSecretConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .secretName(java.lang.String) +// .encryptedValue(java.lang.String) +// .id(java.lang.String) +// .plaintextValue(java.lang.String) +// .selectedRepositoryIds(java.util.List) + .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 | *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 | *No description.* | +| secretName | java.lang.String | Name of the secret. | +| encryptedValue | java.lang.String | Encrypted value of the secret using the GitHub public key in Base64 format. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_user_secret#id CodespacesUserSecret#id}. | +| plaintextValue | java.lang.String | Plaintext value of the secret to be encrypted. | +| selectedRepositoryIds | java.util.List | An array of repository ids that can access the user secret. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_user_secret#secret_name CodespacesUserSecret#secret_name} + +--- + +##### `encryptedValue`Optional + +```java +public java.lang.String getEncryptedValue(); +``` + +- *Type:* java.lang.String + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_user_secret#encrypted_value CodespacesUserSecret#encrypted_value} + +--- + +##### `id`Optional + +```java +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/resources/codespaces_user_secret#id CodespacesUserSecret#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. + +--- + +##### `plaintextValue`Optional + +```java +public java.lang.String getPlaintextValue(); +``` + +- *Type:* java.lang.String + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_user_secret#plaintext_value CodespacesUserSecret#plaintext_value} + +--- + +##### `selectedRepositoryIds`Optional + +```java +public java.util.List getSelectedRepositoryIds(); +``` + +- *Type:* java.util.List + +An array of repository ids that can access the user secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/codespaces_user_secret#selected_repository_ids CodespacesUserSecret#selected_repository_ids} + +--- + + + diff --git a/docs/dataGithubActionsEnvironmentPublicKey.csharp.md b/docs/dataGithubActionsEnvironmentPublicKey.csharp.md new file mode 100644 index 000000000..fecc6e601 --- /dev/null +++ b/docs/dataGithubActionsEnvironmentPublicKey.csharp.md @@ -0,0 +1,806 @@ +# `dataGithubActionsEnvironmentPublicKey` Submodule + +## Constructs + +### DataGithubActionsEnvironmentPublicKey + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_public_key github_actions_environment_public_key}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsEnvironmentPublicKey(Construct Scope, string Id, DataGithubActionsEnvironmentPublicKeyConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubActionsEnvironmentPublicKeyConfig | *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:* DataGithubActionsEnvironmentPublicKeyConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubActionsEnvironmentPublicKey resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsEnvironmentPublicKey.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsEnvironmentPublicKey.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsEnvironmentPublicKey.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsEnvironmentPublicKey.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubActionsEnvironmentPublicKey resource upon running "cdktn 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 DataGithubActionsEnvironmentPublicKey to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubActionsEnvironmentPublicKey that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_public_key#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubActionsEnvironmentPublicKey to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Key | string | *No description.* | +| KeyId | string | *No description.* | +| EnvironmentInput | string | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Environment | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Key`Required + +```csharp +public string Key { get; } +``` + +- *Type:* string + +--- + +##### `KeyId`Required + +```csharp +public string KeyId { get; } +``` + +- *Type:* string + +--- + +##### `EnvironmentInput`Optional + +```csharp +public string EnvironmentInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Environment`Required + +```csharp +public string Environment { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubActionsEnvironmentPublicKeyConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsEnvironmentPublicKeyConfig { + 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 Environment, + string Repository, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Environment | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_public_key#environment DataGithubActionsEnvironmentPublicKey#environment}. | +| Repository | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_public_key#repository DataGithubActionsEnvironmentPublicKey#repository}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_public_key#id DataGithubActionsEnvironmentPublicKey#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Environment`Required + +```csharp +public string Environment { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_public_key#environment DataGithubActionsEnvironmentPublicKey#environment}. + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_public_key#repository DataGithubActionsEnvironmentPublicKey#repository}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_public_key#id DataGithubActionsEnvironmentPublicKey#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. + +--- + + + diff --git a/docs/dataGithubActionsEnvironmentPublicKey.java.md b/docs/dataGithubActionsEnvironmentPublicKey.java.md new file mode 100644 index 000000000..72a852b06 --- /dev/null +++ b/docs/dataGithubActionsEnvironmentPublicKey.java.md @@ -0,0 +1,889 @@ +# `dataGithubActionsEnvironmentPublicKey` Submodule + +## Constructs + +### DataGithubActionsEnvironmentPublicKey + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_public_key github_actions_environment_public_key}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_environment_public_key.DataGithubActionsEnvironmentPublicKey; + +DataGithubActionsEnvironmentPublicKey.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .environment(java.lang.String) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| environment | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_public_key#environment DataGithubActionsEnvironmentPublicKey#environment}. | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_public_key#repository DataGithubActionsEnvironmentPublicKey#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_public_key#id DataGithubActionsEnvironmentPublicKey#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `environment`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_public_key#environment DataGithubActionsEnvironmentPublicKey#environment}. + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_public_key#repository DataGithubActionsEnvironmentPublicKey#repository}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_public_key#id DataGithubActionsEnvironmentPublicKey#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubActionsEnvironmentPublicKey resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_actions_environment_public_key.DataGithubActionsEnvironmentPublicKey; + +DataGithubActionsEnvironmentPublicKey.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` + +```java +import io.cdktn.providers.github.data_github_actions_environment_public_key.DataGithubActionsEnvironmentPublicKey; + +DataGithubActionsEnvironmentPublicKey.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_actions_environment_public_key.DataGithubActionsEnvironmentPublicKey; + +DataGithubActionsEnvironmentPublicKey.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_actions_environment_public_key.DataGithubActionsEnvironmentPublicKey; + +DataGithubActionsEnvironmentPublicKey.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubActionsEnvironmentPublicKey.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubActionsEnvironmentPublicKey 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 DataGithubActionsEnvironmentPublicKey to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubActionsEnvironmentPublicKey that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_public_key#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 DataGithubActionsEnvironmentPublicKey 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| key | java.lang.String | *No description.* | +| keyId | java.lang.String | *No description.* | +| environmentInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| environment | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `key`Required + +```java +public java.lang.String getKey(); +``` + +- *Type:* java.lang.String + +--- + +##### `keyId`Required + +```java +public java.lang.String getKeyId(); +``` + +- *Type:* java.lang.String + +--- + +##### `environmentInput`Optional + +```java +public java.lang.String getEnvironmentInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `environment`Required + +```java +public java.lang.String getEnvironment(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubActionsEnvironmentPublicKeyConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_actions_environment_public_key.DataGithubActionsEnvironmentPublicKeyConfig; + +DataGithubActionsEnvironmentPublicKeyConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .environment(java.lang.String) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| environment | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_public_key#environment DataGithubActionsEnvironmentPublicKey#environment}. | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_public_key#repository DataGithubActionsEnvironmentPublicKey#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_public_key#id DataGithubActionsEnvironmentPublicKey#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `environment`Required + +```java +public java.lang.String getEnvironment(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_public_key#environment DataGithubActionsEnvironmentPublicKey#environment}. + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_public_key#repository DataGithubActionsEnvironmentPublicKey#repository}. + +--- + +##### `id`Optional + +```java +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/actions_environment_public_key#id DataGithubActionsEnvironmentPublicKey#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. + +--- + + + diff --git a/docs/dataGithubActionsEnvironmentSecrets.csharp.md b/docs/dataGithubActionsEnvironmentSecrets.csharp.md new file mode 100644 index 000000000..5fe66e75e --- /dev/null +++ b/docs/dataGithubActionsEnvironmentSecrets.csharp.md @@ -0,0 +1,1308 @@ +# `dataGithubActionsEnvironmentSecrets` Submodule + +## Constructs + +### DataGithubActionsEnvironmentSecrets + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets github_actions_environment_secrets}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsEnvironmentSecrets(Construct Scope, string Id, DataGithubActionsEnvironmentSecretsConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubActionsEnvironmentSecretsConfig | *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:* DataGithubActionsEnvironmentSecretsConfig + +--- + +#### 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.* | +| ResetFullName | *No description.* | +| ResetId | *No description.* | +| ResetName | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetFullName` + +```csharp +private void ResetFullName() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetName` + +```csharp +private void ResetName() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubActionsEnvironmentSecrets resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsEnvironmentSecrets.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsEnvironmentSecrets.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsEnvironmentSecrets.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsEnvironmentSecrets.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubActionsEnvironmentSecrets resource upon running "cdktn 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 DataGithubActionsEnvironmentSecrets to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubActionsEnvironmentSecrets that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubActionsEnvironmentSecrets to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Secrets | DataGithubActionsEnvironmentSecretsSecretsList | *No description.* | +| EnvironmentInput | string | *No description.* | +| FullNameInput | string | *No description.* | +| IdInput | string | *No description.* | +| NameInput | string | *No description.* | +| Environment | string | *No description.* | +| FullName | string | *No description.* | +| Id | string | *No description.* | +| Name | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Secrets`Required + +```csharp +public DataGithubActionsEnvironmentSecretsSecretsList Secrets { get; } +``` + +- *Type:* DataGithubActionsEnvironmentSecretsSecretsList + +--- + +##### `EnvironmentInput`Optional + +```csharp +public string EnvironmentInput { get; } +``` + +- *Type:* string + +--- + +##### `FullNameInput`Optional + +```csharp +public string FullNameInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `Environment`Required + +```csharp +public string Environment { get; } +``` + +- *Type:* string + +--- + +##### `FullName`Required + +```csharp +public string FullName { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubActionsEnvironmentSecretsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsEnvironmentSecretsConfig { + 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 Environment, + string FullName = null, + string Id = null, + string Name = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Environment | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#environment DataGithubActionsEnvironmentSecrets#environment}. | +| FullName | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#full_name DataGithubActionsEnvironmentSecrets#full_name}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#id DataGithubActionsEnvironmentSecrets#id}. | +| Name | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#name DataGithubActionsEnvironmentSecrets#name}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Environment`Required + +```csharp +public string Environment { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#environment DataGithubActionsEnvironmentSecrets#environment}. + +--- + +##### `FullName`Optional + +```csharp +public string FullName { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#full_name DataGithubActionsEnvironmentSecrets#full_name}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#id DataGithubActionsEnvironmentSecrets#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. + +--- + +##### `Name`Optional + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#name DataGithubActionsEnvironmentSecrets#name}. + +--- + +### DataGithubActionsEnvironmentSecretsSecrets + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsEnvironmentSecretsSecrets { + +}; +``` + + +## Classes + +### DataGithubActionsEnvironmentSecretsSecretsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsEnvironmentSecretsSecretsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubActionsEnvironmentSecretsSecretsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubActionsEnvironmentSecretsSecretsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsEnvironmentSecretsSecretsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| CreatedAt | string | *No description.* | +| Name | string | *No description.* | +| UpdatedAt | string | *No description.* | +| InternalValue | DataGithubActionsEnvironmentSecretsSecrets | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubActionsEnvironmentSecretsSecrets InternalValue { get; } +``` + +- *Type:* DataGithubActionsEnvironmentSecretsSecrets + +--- + + + diff --git a/docs/dataGithubActionsEnvironmentSecrets.java.md b/docs/dataGithubActionsEnvironmentSecrets.java.md new file mode 100644 index 000000000..6f0675bfb --- /dev/null +++ b/docs/dataGithubActionsEnvironmentSecrets.java.md @@ -0,0 +1,1400 @@ +# `dataGithubActionsEnvironmentSecrets` Submodule + +## Constructs + +### DataGithubActionsEnvironmentSecrets + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets github_actions_environment_secrets}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_environment_secrets.DataGithubActionsEnvironmentSecrets; + +DataGithubActionsEnvironmentSecrets.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .environment(java.lang.String) +// .fullName(java.lang.String) +// .id(java.lang.String) +// .name(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 | *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 | *No description.* | +| environment | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#environment DataGithubActionsEnvironmentSecrets#environment}. | +| fullName | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#full_name DataGithubActionsEnvironmentSecrets#full_name}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#id DataGithubActionsEnvironmentSecrets#id}. | +| name | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#name DataGithubActionsEnvironmentSecrets#name}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `environment`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#environment DataGithubActionsEnvironmentSecrets#environment}. + +--- + +##### `fullName`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#full_name DataGithubActionsEnvironmentSecrets#full_name}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#id DataGithubActionsEnvironmentSecrets#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. + +--- + +##### `name`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#name DataGithubActionsEnvironmentSecrets#name}. + +--- + +#### 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.* | +| resetFullName | *No description.* | +| resetId | *No description.* | +| resetName | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetFullName` + +```java +public void resetFullName() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetName` + +```java +public void resetName() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubActionsEnvironmentSecrets resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_actions_environment_secrets.DataGithubActionsEnvironmentSecrets; + +DataGithubActionsEnvironmentSecrets.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` + +```java +import io.cdktn.providers.github.data_github_actions_environment_secrets.DataGithubActionsEnvironmentSecrets; + +DataGithubActionsEnvironmentSecrets.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_actions_environment_secrets.DataGithubActionsEnvironmentSecrets; + +DataGithubActionsEnvironmentSecrets.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_actions_environment_secrets.DataGithubActionsEnvironmentSecrets; + +DataGithubActionsEnvironmentSecrets.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubActionsEnvironmentSecrets.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubActionsEnvironmentSecrets 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 DataGithubActionsEnvironmentSecrets to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubActionsEnvironmentSecrets that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#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 DataGithubActionsEnvironmentSecrets 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| secrets | DataGithubActionsEnvironmentSecretsSecretsList | *No description.* | +| environmentInput | java.lang.String | *No description.* | +| fullNameInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| environment | java.lang.String | *No description.* | +| fullName | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `secrets`Required + +```java +public DataGithubActionsEnvironmentSecretsSecretsList getSecrets(); +``` + +- *Type:* DataGithubActionsEnvironmentSecretsSecretsList + +--- + +##### `environmentInput`Optional + +```java +public java.lang.String getEnvironmentInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `fullNameInput`Optional + +```java +public java.lang.String getFullNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `environment`Required + +```java +public java.lang.String getEnvironment(); +``` + +- *Type:* java.lang.String + +--- + +##### `fullName`Required + +```java +public java.lang.String getFullName(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubActionsEnvironmentSecretsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_actions_environment_secrets.DataGithubActionsEnvironmentSecretsConfig; + +DataGithubActionsEnvironmentSecretsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .environment(java.lang.String) +// .fullName(java.lang.String) +// .id(java.lang.String) +// .name(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 | *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 | *No description.* | +| environment | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#environment DataGithubActionsEnvironmentSecrets#environment}. | +| fullName | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#full_name DataGithubActionsEnvironmentSecrets#full_name}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#id DataGithubActionsEnvironmentSecrets#id}. | +| name | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#name DataGithubActionsEnvironmentSecrets#name}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `environment`Required + +```java +public java.lang.String getEnvironment(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#environment DataGithubActionsEnvironmentSecrets#environment}. + +--- + +##### `fullName`Optional + +```java +public java.lang.String getFullName(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_secrets#full_name DataGithubActionsEnvironmentSecrets#full_name}. + +--- + +##### `id`Optional + +```java +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/actions_environment_secrets#id DataGithubActionsEnvironmentSecrets#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. + +--- + +##### `name`Optional + +```java +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/actions_environment_secrets#name DataGithubActionsEnvironmentSecrets#name}. + +--- + +### DataGithubActionsEnvironmentSecretsSecrets + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_actions_environment_secrets.DataGithubActionsEnvironmentSecretsSecrets; + +DataGithubActionsEnvironmentSecretsSecrets.builder() + .build(); +``` + + +## Classes + +### DataGithubActionsEnvironmentSecretsSecretsList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_environment_secrets.DataGithubActionsEnvironmentSecretsSecretsList; + +new DataGithubActionsEnvironmentSecretsSecretsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubActionsEnvironmentSecretsSecretsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubActionsEnvironmentSecretsSecretsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_environment_secrets.DataGithubActionsEnvironmentSecretsSecretsOutputReference; + +new DataGithubActionsEnvironmentSecretsSecretsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| createdAt | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| internalValue | DataGithubActionsEnvironmentSecretsSecrets | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubActionsEnvironmentSecretsSecrets getInternalValue(); +``` + +- *Type:* DataGithubActionsEnvironmentSecretsSecrets + +--- + + + diff --git a/docs/dataGithubActionsEnvironmentVariables.csharp.md b/docs/dataGithubActionsEnvironmentVariables.csharp.md new file mode 100644 index 000000000..1b26e2ada --- /dev/null +++ b/docs/dataGithubActionsEnvironmentVariables.csharp.md @@ -0,0 +1,1319 @@ +# `dataGithubActionsEnvironmentVariables` Submodule + +## Constructs + +### DataGithubActionsEnvironmentVariables + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables github_actions_environment_variables}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsEnvironmentVariables(Construct Scope, string Id, DataGithubActionsEnvironmentVariablesConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubActionsEnvironmentVariablesConfig | *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:* DataGithubActionsEnvironmentVariablesConfig + +--- + +#### 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.* | +| ResetFullName | *No description.* | +| ResetId | *No description.* | +| ResetName | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetFullName` + +```csharp +private void ResetFullName() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetName` + +```csharp +private void ResetName() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubActionsEnvironmentVariables resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsEnvironmentVariables.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsEnvironmentVariables.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsEnvironmentVariables.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsEnvironmentVariables.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubActionsEnvironmentVariables resource upon running "cdktn 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 DataGithubActionsEnvironmentVariables to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubActionsEnvironmentVariables that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubActionsEnvironmentVariables to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Variables | DataGithubActionsEnvironmentVariablesVariablesList | *No description.* | +| EnvironmentInput | string | *No description.* | +| FullNameInput | string | *No description.* | +| IdInput | string | *No description.* | +| NameInput | string | *No description.* | +| Environment | string | *No description.* | +| FullName | string | *No description.* | +| Id | string | *No description.* | +| Name | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Variables`Required + +```csharp +public DataGithubActionsEnvironmentVariablesVariablesList Variables { get; } +``` + +- *Type:* DataGithubActionsEnvironmentVariablesVariablesList + +--- + +##### `EnvironmentInput`Optional + +```csharp +public string EnvironmentInput { get; } +``` + +- *Type:* string + +--- + +##### `FullNameInput`Optional + +```csharp +public string FullNameInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `Environment`Required + +```csharp +public string Environment { get; } +``` + +- *Type:* string + +--- + +##### `FullName`Required + +```csharp +public string FullName { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubActionsEnvironmentVariablesConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsEnvironmentVariablesConfig { + 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 Environment, + string FullName = null, + string Id = null, + string Name = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Environment | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#environment DataGithubActionsEnvironmentVariables#environment}. | +| FullName | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#full_name DataGithubActionsEnvironmentVariables#full_name}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#id DataGithubActionsEnvironmentVariables#id}. | +| Name | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#name DataGithubActionsEnvironmentVariables#name}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Environment`Required + +```csharp +public string Environment { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#environment DataGithubActionsEnvironmentVariables#environment}. + +--- + +##### `FullName`Optional + +```csharp +public string FullName { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#full_name DataGithubActionsEnvironmentVariables#full_name}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#id DataGithubActionsEnvironmentVariables#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. + +--- + +##### `Name`Optional + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#name DataGithubActionsEnvironmentVariables#name}. + +--- + +### DataGithubActionsEnvironmentVariablesVariables + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsEnvironmentVariablesVariables { + +}; +``` + + +## Classes + +### DataGithubActionsEnvironmentVariablesVariablesList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsEnvironmentVariablesVariablesList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubActionsEnvironmentVariablesVariablesOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubActionsEnvironmentVariablesVariablesOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsEnvironmentVariablesVariablesOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| CreatedAt | string | *No description.* | +| Name | string | *No description.* | +| UpdatedAt | string | *No description.* | +| Value | string | *No description.* | +| InternalValue | DataGithubActionsEnvironmentVariablesVariables | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Value`Required + +```csharp +public string Value { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubActionsEnvironmentVariablesVariables InternalValue { get; } +``` + +- *Type:* DataGithubActionsEnvironmentVariablesVariables + +--- + + + diff --git a/docs/dataGithubActionsEnvironmentVariables.java.md b/docs/dataGithubActionsEnvironmentVariables.java.md new file mode 100644 index 000000000..0ab4ca07f --- /dev/null +++ b/docs/dataGithubActionsEnvironmentVariables.java.md @@ -0,0 +1,1411 @@ +# `dataGithubActionsEnvironmentVariables` Submodule + +## Constructs + +### DataGithubActionsEnvironmentVariables + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables github_actions_environment_variables}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_environment_variables.DataGithubActionsEnvironmentVariables; + +DataGithubActionsEnvironmentVariables.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .environment(java.lang.String) +// .fullName(java.lang.String) +// .id(java.lang.String) +// .name(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 | *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 | *No description.* | +| environment | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#environment DataGithubActionsEnvironmentVariables#environment}. | +| fullName | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#full_name DataGithubActionsEnvironmentVariables#full_name}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#id DataGithubActionsEnvironmentVariables#id}. | +| name | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#name DataGithubActionsEnvironmentVariables#name}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `environment`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#environment DataGithubActionsEnvironmentVariables#environment}. + +--- + +##### `fullName`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#full_name DataGithubActionsEnvironmentVariables#full_name}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#id DataGithubActionsEnvironmentVariables#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. + +--- + +##### `name`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#name DataGithubActionsEnvironmentVariables#name}. + +--- + +#### 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.* | +| resetFullName | *No description.* | +| resetId | *No description.* | +| resetName | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetFullName` + +```java +public void resetFullName() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetName` + +```java +public void resetName() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubActionsEnvironmentVariables resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_actions_environment_variables.DataGithubActionsEnvironmentVariables; + +DataGithubActionsEnvironmentVariables.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` + +```java +import io.cdktn.providers.github.data_github_actions_environment_variables.DataGithubActionsEnvironmentVariables; + +DataGithubActionsEnvironmentVariables.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_actions_environment_variables.DataGithubActionsEnvironmentVariables; + +DataGithubActionsEnvironmentVariables.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_actions_environment_variables.DataGithubActionsEnvironmentVariables; + +DataGithubActionsEnvironmentVariables.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubActionsEnvironmentVariables.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubActionsEnvironmentVariables 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 DataGithubActionsEnvironmentVariables to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubActionsEnvironmentVariables that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#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 DataGithubActionsEnvironmentVariables 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| variables | DataGithubActionsEnvironmentVariablesVariablesList | *No description.* | +| environmentInput | java.lang.String | *No description.* | +| fullNameInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| environment | java.lang.String | *No description.* | +| fullName | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `variables`Required + +```java +public DataGithubActionsEnvironmentVariablesVariablesList getVariables(); +``` + +- *Type:* DataGithubActionsEnvironmentVariablesVariablesList + +--- + +##### `environmentInput`Optional + +```java +public java.lang.String getEnvironmentInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `fullNameInput`Optional + +```java +public java.lang.String getFullNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `environment`Required + +```java +public java.lang.String getEnvironment(); +``` + +- *Type:* java.lang.String + +--- + +##### `fullName`Required + +```java +public java.lang.String getFullName(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubActionsEnvironmentVariablesConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_actions_environment_variables.DataGithubActionsEnvironmentVariablesConfig; + +DataGithubActionsEnvironmentVariablesConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .environment(java.lang.String) +// .fullName(java.lang.String) +// .id(java.lang.String) +// .name(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 | *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 | *No description.* | +| environment | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#environment DataGithubActionsEnvironmentVariables#environment}. | +| fullName | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#full_name DataGithubActionsEnvironmentVariables#full_name}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#id DataGithubActionsEnvironmentVariables#id}. | +| name | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#name DataGithubActionsEnvironmentVariables#name}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `environment`Required + +```java +public java.lang.String getEnvironment(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#environment DataGithubActionsEnvironmentVariables#environment}. + +--- + +##### `fullName`Optional + +```java +public java.lang.String getFullName(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_environment_variables#full_name DataGithubActionsEnvironmentVariables#full_name}. + +--- + +##### `id`Optional + +```java +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/actions_environment_variables#id DataGithubActionsEnvironmentVariables#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. + +--- + +##### `name`Optional + +```java +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/actions_environment_variables#name DataGithubActionsEnvironmentVariables#name}. + +--- + +### DataGithubActionsEnvironmentVariablesVariables + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_actions_environment_variables.DataGithubActionsEnvironmentVariablesVariables; + +DataGithubActionsEnvironmentVariablesVariables.builder() + .build(); +``` + + +## Classes + +### DataGithubActionsEnvironmentVariablesVariablesList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_environment_variables.DataGithubActionsEnvironmentVariablesVariablesList; + +new DataGithubActionsEnvironmentVariablesVariablesList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubActionsEnvironmentVariablesVariablesOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubActionsEnvironmentVariablesVariablesOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_environment_variables.DataGithubActionsEnvironmentVariablesVariablesOutputReference; + +new DataGithubActionsEnvironmentVariablesVariablesOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| createdAt | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| value | java.lang.String | *No description.* | +| internalValue | DataGithubActionsEnvironmentVariablesVariables | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `value`Required + +```java +public java.lang.String getValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubActionsEnvironmentVariablesVariables getInternalValue(); +``` + +- *Type:* DataGithubActionsEnvironmentVariablesVariables + +--- + + + diff --git a/docs/dataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate.csharp.md b/docs/dataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate.csharp.md new file mode 100644 index 000000000..159d88f58 --- /dev/null +++ b/docs/dataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate.csharp.md @@ -0,0 +1,723 @@ +# `dataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate` Submodule + +## Constructs + +### DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_oidc_subject_claim_customization_template github_actions_organization_oidc_subject_claim_customization_template}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate(Construct Scope, string Id, DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplateConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplateConfig | *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`Optional + +- *Type:* DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplateConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate resource upon running "cdktn 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 DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_oidc_subject_claim_customization_template#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| IncludeClaimKeys | string[] | *No description.* | +| IdInput | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `IncludeClaimKeys`Required + +```csharp +public string[] IncludeClaimKeys { get; } +``` + +- *Type:* string[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplateConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplateConfig { + 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 Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_oidc_subject_claim_customization_template#id DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_oidc_subject_claim_customization_template#id DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate#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. + +--- + + + diff --git a/docs/dataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate.java.md b/docs/dataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate.java.md new file mode 100644 index 000000000..4e3d59925 --- /dev/null +++ b/docs/dataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate.java.md @@ -0,0 +1,786 @@ +# `dataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate` Submodule + +## Constructs + +### DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_oidc_subject_claim_customization_template github_actions_organization_oidc_subject_claim_customization_template}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_organization_oidc_subject_claim_customization_template.DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate; + +DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_oidc_subject_claim_customization_template#id DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_oidc_subject_claim_customization_template#id DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_actions_organization_oidc_subject_claim_customization_template.DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate; + +DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate.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` + +```java +import io.cdktn.providers.github.data_github_actions_organization_oidc_subject_claim_customization_template.DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate; + +DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_actions_organization_oidc_subject_claim_customization_template.DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate; + +DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_actions_organization_oidc_subject_claim_customization_template.DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate; + +DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate 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 DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_oidc_subject_claim_customization_template#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 DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| includeClaimKeys | java.util.List | *No description.* | +| idInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `includeClaimKeys`Required + +```java +public java.util.List getIncludeClaimKeys(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplateConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_actions_organization_oidc_subject_claim_customization_template.DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplateConfig; + +DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplateConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_oidc_subject_claim_customization_template#id DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Optional + +```java +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/actions_organization_oidc_subject_claim_customization_template#id DataGithubActionsOrganizationOidcSubjectClaimCustomizationTemplate#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. + +--- + + + diff --git a/docs/dataGithubActionsOrganizationPublicKey.csharp.md b/docs/dataGithubActionsOrganizationPublicKey.csharp.md new file mode 100644 index 000000000..70ad597d7 --- /dev/null +++ b/docs/dataGithubActionsOrganizationPublicKey.csharp.md @@ -0,0 +1,734 @@ +# `dataGithubActionsOrganizationPublicKey` Submodule + +## Constructs + +### DataGithubActionsOrganizationPublicKey + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_public_key github_actions_organization_public_key}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsOrganizationPublicKey(Construct Scope, string Id, DataGithubActionsOrganizationPublicKeyConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubActionsOrganizationPublicKeyConfig | *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`Optional + +- *Type:* DataGithubActionsOrganizationPublicKeyConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubActionsOrganizationPublicKey resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsOrganizationPublicKey.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsOrganizationPublicKey.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsOrganizationPublicKey.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsOrganizationPublicKey.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubActionsOrganizationPublicKey resource upon running "cdktn 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 DataGithubActionsOrganizationPublicKey to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubActionsOrganizationPublicKey that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_public_key#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubActionsOrganizationPublicKey to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Key | string | *No description.* | +| KeyId | string | *No description.* | +| IdInput | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Key`Required + +```csharp +public string Key { get; } +``` + +- *Type:* string + +--- + +##### `KeyId`Required + +```csharp +public string KeyId { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubActionsOrganizationPublicKeyConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsOrganizationPublicKeyConfig { + 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 Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_public_key#id DataGithubActionsOrganizationPublicKey#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_public_key#id DataGithubActionsOrganizationPublicKey#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. + +--- + + + diff --git a/docs/dataGithubActionsOrganizationPublicKey.java.md b/docs/dataGithubActionsOrganizationPublicKey.java.md new file mode 100644 index 000000000..6ef4a32fa --- /dev/null +++ b/docs/dataGithubActionsOrganizationPublicKey.java.md @@ -0,0 +1,797 @@ +# `dataGithubActionsOrganizationPublicKey` Submodule + +## Constructs + +### DataGithubActionsOrganizationPublicKey + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_public_key github_actions_organization_public_key}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_organization_public_key.DataGithubActionsOrganizationPublicKey; + +DataGithubActionsOrganizationPublicKey.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_public_key#id DataGithubActionsOrganizationPublicKey#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_public_key#id DataGithubActionsOrganizationPublicKey#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubActionsOrganizationPublicKey resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_actions_organization_public_key.DataGithubActionsOrganizationPublicKey; + +DataGithubActionsOrganizationPublicKey.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` + +```java +import io.cdktn.providers.github.data_github_actions_organization_public_key.DataGithubActionsOrganizationPublicKey; + +DataGithubActionsOrganizationPublicKey.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_actions_organization_public_key.DataGithubActionsOrganizationPublicKey; + +DataGithubActionsOrganizationPublicKey.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_actions_organization_public_key.DataGithubActionsOrganizationPublicKey; + +DataGithubActionsOrganizationPublicKey.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubActionsOrganizationPublicKey.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubActionsOrganizationPublicKey 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 DataGithubActionsOrganizationPublicKey to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubActionsOrganizationPublicKey that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_public_key#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 DataGithubActionsOrganizationPublicKey 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| key | java.lang.String | *No description.* | +| keyId | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `key`Required + +```java +public java.lang.String getKey(); +``` + +- *Type:* java.lang.String + +--- + +##### `keyId`Required + +```java +public java.lang.String getKeyId(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubActionsOrganizationPublicKeyConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_actions_organization_public_key.DataGithubActionsOrganizationPublicKeyConfig; + +DataGithubActionsOrganizationPublicKeyConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_public_key#id DataGithubActionsOrganizationPublicKey#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Optional + +```java +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/actions_organization_public_key#id DataGithubActionsOrganizationPublicKey#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. + +--- + + + diff --git a/docs/dataGithubActionsOrganizationRegistrationToken.csharp.md b/docs/dataGithubActionsOrganizationRegistrationToken.csharp.md new file mode 100644 index 000000000..623aab030 --- /dev/null +++ b/docs/dataGithubActionsOrganizationRegistrationToken.csharp.md @@ -0,0 +1,734 @@ +# `dataGithubActionsOrganizationRegistrationToken` Submodule + +## Constructs + +### DataGithubActionsOrganizationRegistrationToken + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_registration_token github_actions_organization_registration_token}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsOrganizationRegistrationToken(Construct Scope, string Id, DataGithubActionsOrganizationRegistrationTokenConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubActionsOrganizationRegistrationTokenConfig | *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`Optional + +- *Type:* DataGithubActionsOrganizationRegistrationTokenConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubActionsOrganizationRegistrationToken resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsOrganizationRegistrationToken.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsOrganizationRegistrationToken.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsOrganizationRegistrationToken.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsOrganizationRegistrationToken.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubActionsOrganizationRegistrationToken resource upon running "cdktn 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 DataGithubActionsOrganizationRegistrationToken to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubActionsOrganizationRegistrationToken that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_registration_token#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubActionsOrganizationRegistrationToken to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| ExpiresAt | double | *No description.* | +| Token | string | *No description.* | +| IdInput | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `ExpiresAt`Required + +```csharp +public double ExpiresAt { get; } +``` + +- *Type:* double + +--- + +##### `Token`Required + +```csharp +public string Token { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubActionsOrganizationRegistrationTokenConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsOrganizationRegistrationTokenConfig { + 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 Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_registration_token#id DataGithubActionsOrganizationRegistrationToken#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_registration_token#id DataGithubActionsOrganizationRegistrationToken#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. + +--- + + + diff --git a/docs/dataGithubActionsOrganizationRegistrationToken.java.md b/docs/dataGithubActionsOrganizationRegistrationToken.java.md new file mode 100644 index 000000000..4f58f2731 --- /dev/null +++ b/docs/dataGithubActionsOrganizationRegistrationToken.java.md @@ -0,0 +1,797 @@ +# `dataGithubActionsOrganizationRegistrationToken` Submodule + +## Constructs + +### DataGithubActionsOrganizationRegistrationToken + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_registration_token github_actions_organization_registration_token}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_organization_registration_token.DataGithubActionsOrganizationRegistrationToken; + +DataGithubActionsOrganizationRegistrationToken.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_registration_token#id DataGithubActionsOrganizationRegistrationToken#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_registration_token#id DataGithubActionsOrganizationRegistrationToken#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubActionsOrganizationRegistrationToken resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_actions_organization_registration_token.DataGithubActionsOrganizationRegistrationToken; + +DataGithubActionsOrganizationRegistrationToken.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` + +```java +import io.cdktn.providers.github.data_github_actions_organization_registration_token.DataGithubActionsOrganizationRegistrationToken; + +DataGithubActionsOrganizationRegistrationToken.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_actions_organization_registration_token.DataGithubActionsOrganizationRegistrationToken; + +DataGithubActionsOrganizationRegistrationToken.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_actions_organization_registration_token.DataGithubActionsOrganizationRegistrationToken; + +DataGithubActionsOrganizationRegistrationToken.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubActionsOrganizationRegistrationToken.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubActionsOrganizationRegistrationToken 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 DataGithubActionsOrganizationRegistrationToken to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubActionsOrganizationRegistrationToken that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_registration_token#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 DataGithubActionsOrganizationRegistrationToken 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| expiresAt | java.lang.Number | *No description.* | +| token | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `expiresAt`Required + +```java +public java.lang.Number getExpiresAt(); +``` + +- *Type:* java.lang.Number + +--- + +##### `token`Required + +```java +public java.lang.String getToken(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubActionsOrganizationRegistrationTokenConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_actions_organization_registration_token.DataGithubActionsOrganizationRegistrationTokenConfig; + +DataGithubActionsOrganizationRegistrationTokenConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_registration_token#id DataGithubActionsOrganizationRegistrationToken#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Optional + +```java +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/actions_organization_registration_token#id DataGithubActionsOrganizationRegistrationToken#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. + +--- + + + diff --git a/docs/dataGithubActionsOrganizationSecrets.csharp.md b/docs/dataGithubActionsOrganizationSecrets.csharp.md new file mode 100644 index 000000000..434320416 --- /dev/null +++ b/docs/dataGithubActionsOrganizationSecrets.csharp.md @@ -0,0 +1,1197 @@ +# `dataGithubActionsOrganizationSecrets` Submodule + +## Constructs + +### DataGithubActionsOrganizationSecrets + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_secrets github_actions_organization_secrets}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsOrganizationSecrets(Construct Scope, string Id, DataGithubActionsOrganizationSecretsConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubActionsOrganizationSecretsConfig | *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`Optional + +- *Type:* DataGithubActionsOrganizationSecretsConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubActionsOrganizationSecrets resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsOrganizationSecrets.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsOrganizationSecrets.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsOrganizationSecrets.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsOrganizationSecrets.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubActionsOrganizationSecrets resource upon running "cdktn 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 DataGithubActionsOrganizationSecrets to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubActionsOrganizationSecrets that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_secrets#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubActionsOrganizationSecrets to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Secrets | DataGithubActionsOrganizationSecretsSecretsList | *No description.* | +| IdInput | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Secrets`Required + +```csharp +public DataGithubActionsOrganizationSecretsSecretsList Secrets { get; } +``` + +- *Type:* DataGithubActionsOrganizationSecretsSecretsList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubActionsOrganizationSecretsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsOrganizationSecretsConfig { + 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 Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_secrets#id DataGithubActionsOrganizationSecrets#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_secrets#id DataGithubActionsOrganizationSecrets#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. + +--- + +### DataGithubActionsOrganizationSecretsSecrets + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsOrganizationSecretsSecrets { + +}; +``` + + +## Classes + +### DataGithubActionsOrganizationSecretsSecretsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsOrganizationSecretsSecretsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubActionsOrganizationSecretsSecretsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubActionsOrganizationSecretsSecretsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsOrganizationSecretsSecretsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| CreatedAt | string | *No description.* | +| Name | string | *No description.* | +| UpdatedAt | string | *No description.* | +| Visibility | string | *No description.* | +| InternalValue | DataGithubActionsOrganizationSecretsSecrets | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Visibility`Required + +```csharp +public string Visibility { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubActionsOrganizationSecretsSecrets InternalValue { get; } +``` + +- *Type:* DataGithubActionsOrganizationSecretsSecrets + +--- + + + diff --git a/docs/dataGithubActionsOrganizationSecrets.java.md b/docs/dataGithubActionsOrganizationSecrets.java.md new file mode 100644 index 000000000..0e92a245d --- /dev/null +++ b/docs/dataGithubActionsOrganizationSecrets.java.md @@ -0,0 +1,1259 @@ +# `dataGithubActionsOrganizationSecrets` Submodule + +## Constructs + +### DataGithubActionsOrganizationSecrets + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_secrets github_actions_organization_secrets}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_organization_secrets.DataGithubActionsOrganizationSecrets; + +DataGithubActionsOrganizationSecrets.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_secrets#id DataGithubActionsOrganizationSecrets#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_secrets#id DataGithubActionsOrganizationSecrets#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubActionsOrganizationSecrets resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_actions_organization_secrets.DataGithubActionsOrganizationSecrets; + +DataGithubActionsOrganizationSecrets.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` + +```java +import io.cdktn.providers.github.data_github_actions_organization_secrets.DataGithubActionsOrganizationSecrets; + +DataGithubActionsOrganizationSecrets.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_actions_organization_secrets.DataGithubActionsOrganizationSecrets; + +DataGithubActionsOrganizationSecrets.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_actions_organization_secrets.DataGithubActionsOrganizationSecrets; + +DataGithubActionsOrganizationSecrets.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubActionsOrganizationSecrets.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubActionsOrganizationSecrets 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 DataGithubActionsOrganizationSecrets to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubActionsOrganizationSecrets that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_secrets#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 DataGithubActionsOrganizationSecrets 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| secrets | DataGithubActionsOrganizationSecretsSecretsList | *No description.* | +| idInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `secrets`Required + +```java +public DataGithubActionsOrganizationSecretsSecretsList getSecrets(); +``` + +- *Type:* DataGithubActionsOrganizationSecretsSecretsList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubActionsOrganizationSecretsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_actions_organization_secrets.DataGithubActionsOrganizationSecretsConfig; + +DataGithubActionsOrganizationSecretsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_secrets#id DataGithubActionsOrganizationSecrets#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Optional + +```java +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/actions_organization_secrets#id DataGithubActionsOrganizationSecrets#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. + +--- + +### DataGithubActionsOrganizationSecretsSecrets + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_actions_organization_secrets.DataGithubActionsOrganizationSecretsSecrets; + +DataGithubActionsOrganizationSecretsSecrets.builder() + .build(); +``` + + +## Classes + +### DataGithubActionsOrganizationSecretsSecretsList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_organization_secrets.DataGithubActionsOrganizationSecretsSecretsList; + +new DataGithubActionsOrganizationSecretsSecretsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubActionsOrganizationSecretsSecretsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubActionsOrganizationSecretsSecretsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_organization_secrets.DataGithubActionsOrganizationSecretsSecretsOutputReference; + +new DataGithubActionsOrganizationSecretsSecretsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| createdAt | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| visibility | java.lang.String | *No description.* | +| internalValue | DataGithubActionsOrganizationSecretsSecrets | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `visibility`Required + +```java +public java.lang.String getVisibility(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubActionsOrganizationSecretsSecrets getInternalValue(); +``` + +- *Type:* DataGithubActionsOrganizationSecretsSecrets + +--- + + + diff --git a/docs/dataGithubActionsOrganizationVariables.csharp.md b/docs/dataGithubActionsOrganizationVariables.csharp.md new file mode 100644 index 000000000..fc37ed391 --- /dev/null +++ b/docs/dataGithubActionsOrganizationVariables.csharp.md @@ -0,0 +1,1208 @@ +# `dataGithubActionsOrganizationVariables` Submodule + +## Constructs + +### DataGithubActionsOrganizationVariables + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_variables github_actions_organization_variables}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsOrganizationVariables(Construct Scope, string Id, DataGithubActionsOrganizationVariablesConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubActionsOrganizationVariablesConfig | *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`Optional + +- *Type:* DataGithubActionsOrganizationVariablesConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubActionsOrganizationVariables resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsOrganizationVariables.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsOrganizationVariables.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsOrganizationVariables.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsOrganizationVariables.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubActionsOrganizationVariables resource upon running "cdktn 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 DataGithubActionsOrganizationVariables to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubActionsOrganizationVariables that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_variables#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubActionsOrganizationVariables to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Variables | DataGithubActionsOrganizationVariablesVariablesList | *No description.* | +| IdInput | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Variables`Required + +```csharp +public DataGithubActionsOrganizationVariablesVariablesList Variables { get; } +``` + +- *Type:* DataGithubActionsOrganizationVariablesVariablesList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubActionsOrganizationVariablesConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsOrganizationVariablesConfig { + 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 Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_variables#id DataGithubActionsOrganizationVariables#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_variables#id DataGithubActionsOrganizationVariables#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. + +--- + +### DataGithubActionsOrganizationVariablesVariables + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsOrganizationVariablesVariables { + +}; +``` + + +## Classes + +### DataGithubActionsOrganizationVariablesVariablesList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsOrganizationVariablesVariablesList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubActionsOrganizationVariablesVariablesOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubActionsOrganizationVariablesVariablesOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsOrganizationVariablesVariablesOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| CreatedAt | string | *No description.* | +| Name | string | *No description.* | +| UpdatedAt | string | *No description.* | +| Value | string | *No description.* | +| Visibility | string | *No description.* | +| InternalValue | DataGithubActionsOrganizationVariablesVariables | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Value`Required + +```csharp +public string Value { get; } +``` + +- *Type:* string + +--- + +##### `Visibility`Required + +```csharp +public string Visibility { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubActionsOrganizationVariablesVariables InternalValue { get; } +``` + +- *Type:* DataGithubActionsOrganizationVariablesVariables + +--- + + + diff --git a/docs/dataGithubActionsOrganizationVariables.java.md b/docs/dataGithubActionsOrganizationVariables.java.md new file mode 100644 index 000000000..acd835a5f --- /dev/null +++ b/docs/dataGithubActionsOrganizationVariables.java.md @@ -0,0 +1,1270 @@ +# `dataGithubActionsOrganizationVariables` Submodule + +## Constructs + +### DataGithubActionsOrganizationVariables + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_variables github_actions_organization_variables}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_organization_variables.DataGithubActionsOrganizationVariables; + +DataGithubActionsOrganizationVariables.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_variables#id DataGithubActionsOrganizationVariables#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_variables#id DataGithubActionsOrganizationVariables#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubActionsOrganizationVariables resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_actions_organization_variables.DataGithubActionsOrganizationVariables; + +DataGithubActionsOrganizationVariables.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` + +```java +import io.cdktn.providers.github.data_github_actions_organization_variables.DataGithubActionsOrganizationVariables; + +DataGithubActionsOrganizationVariables.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_actions_organization_variables.DataGithubActionsOrganizationVariables; + +DataGithubActionsOrganizationVariables.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_actions_organization_variables.DataGithubActionsOrganizationVariables; + +DataGithubActionsOrganizationVariables.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubActionsOrganizationVariables.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubActionsOrganizationVariables 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 DataGithubActionsOrganizationVariables to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubActionsOrganizationVariables that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_variables#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 DataGithubActionsOrganizationVariables 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| variables | DataGithubActionsOrganizationVariablesVariablesList | *No description.* | +| idInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `variables`Required + +```java +public DataGithubActionsOrganizationVariablesVariablesList getVariables(); +``` + +- *Type:* DataGithubActionsOrganizationVariablesVariablesList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubActionsOrganizationVariablesConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_actions_organization_variables.DataGithubActionsOrganizationVariablesConfig; + +DataGithubActionsOrganizationVariablesConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_organization_variables#id DataGithubActionsOrganizationVariables#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Optional + +```java +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/actions_organization_variables#id DataGithubActionsOrganizationVariables#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. + +--- + +### DataGithubActionsOrganizationVariablesVariables + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_actions_organization_variables.DataGithubActionsOrganizationVariablesVariables; + +DataGithubActionsOrganizationVariablesVariables.builder() + .build(); +``` + + +## Classes + +### DataGithubActionsOrganizationVariablesVariablesList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_organization_variables.DataGithubActionsOrganizationVariablesVariablesList; + +new DataGithubActionsOrganizationVariablesVariablesList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubActionsOrganizationVariablesVariablesOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubActionsOrganizationVariablesVariablesOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_organization_variables.DataGithubActionsOrganizationVariablesVariablesOutputReference; + +new DataGithubActionsOrganizationVariablesVariablesOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| createdAt | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| value | java.lang.String | *No description.* | +| visibility | java.lang.String | *No description.* | +| internalValue | DataGithubActionsOrganizationVariablesVariables | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `value`Required + +```java +public java.lang.String getValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `visibility`Required + +```java +public java.lang.String getVisibility(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubActionsOrganizationVariablesVariables getInternalValue(); +``` + +- *Type:* DataGithubActionsOrganizationVariablesVariables + +--- + + + diff --git a/docs/dataGithubActionsPublicKey.csharp.md b/docs/dataGithubActionsPublicKey.csharp.md new file mode 100644 index 000000000..bb1c6c43f --- /dev/null +++ b/docs/dataGithubActionsPublicKey.csharp.md @@ -0,0 +1,770 @@ +# `dataGithubActionsPublicKey` Submodule + +## Constructs + +### DataGithubActionsPublicKey + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_public_key github_actions_public_key}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsPublicKey(Construct Scope, string Id, DataGithubActionsPublicKeyConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubActionsPublicKeyConfig | *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:* DataGithubActionsPublicKeyConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubActionsPublicKey resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsPublicKey.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsPublicKey.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsPublicKey.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsPublicKey.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubActionsPublicKey resource upon running "cdktn 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 DataGithubActionsPublicKey to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubActionsPublicKey that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_public_key#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubActionsPublicKey to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Key | string | *No description.* | +| KeyId | string | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Key`Required + +```csharp +public string Key { get; } +``` + +- *Type:* string + +--- + +##### `KeyId`Required + +```csharp +public string KeyId { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubActionsPublicKeyConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsPublicKeyConfig { + 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 Repository, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_public_key#repository DataGithubActionsPublicKey#repository}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_public_key#id DataGithubActionsPublicKey#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_public_key#repository DataGithubActionsPublicKey#repository}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_public_key#id DataGithubActionsPublicKey#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. + +--- + + + diff --git a/docs/dataGithubActionsPublicKey.java.md b/docs/dataGithubActionsPublicKey.java.md new file mode 100644 index 000000000..9c2f46ec8 --- /dev/null +++ b/docs/dataGithubActionsPublicKey.java.md @@ -0,0 +1,843 @@ +# `dataGithubActionsPublicKey` Submodule + +## Constructs + +### DataGithubActionsPublicKey + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_public_key github_actions_public_key}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_public_key.DataGithubActionsPublicKey; + +DataGithubActionsPublicKey.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_public_key#repository DataGithubActionsPublicKey#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_public_key#id DataGithubActionsPublicKey#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_public_key#repository DataGithubActionsPublicKey#repository}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_public_key#id DataGithubActionsPublicKey#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubActionsPublicKey resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_actions_public_key.DataGithubActionsPublicKey; + +DataGithubActionsPublicKey.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` + +```java +import io.cdktn.providers.github.data_github_actions_public_key.DataGithubActionsPublicKey; + +DataGithubActionsPublicKey.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_actions_public_key.DataGithubActionsPublicKey; + +DataGithubActionsPublicKey.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_actions_public_key.DataGithubActionsPublicKey; + +DataGithubActionsPublicKey.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubActionsPublicKey.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubActionsPublicKey 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 DataGithubActionsPublicKey to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubActionsPublicKey that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_public_key#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 DataGithubActionsPublicKey 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| key | java.lang.String | *No description.* | +| keyId | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `key`Required + +```java +public java.lang.String getKey(); +``` + +- *Type:* java.lang.String + +--- + +##### `keyId`Required + +```java +public java.lang.String getKeyId(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubActionsPublicKeyConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_actions_public_key.DataGithubActionsPublicKeyConfig; + +DataGithubActionsPublicKeyConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_public_key#repository DataGithubActionsPublicKey#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_public_key#id DataGithubActionsPublicKey#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_public_key#repository DataGithubActionsPublicKey#repository}. + +--- + +##### `id`Optional + +```java +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/actions_public_key#id DataGithubActionsPublicKey#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. + +--- + + + diff --git a/docs/dataGithubActionsRegistrationToken.csharp.md b/docs/dataGithubActionsRegistrationToken.csharp.md new file mode 100644 index 000000000..f2d5b982b --- /dev/null +++ b/docs/dataGithubActionsRegistrationToken.csharp.md @@ -0,0 +1,770 @@ +# `dataGithubActionsRegistrationToken` Submodule + +## Constructs + +### DataGithubActionsRegistrationToken + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_registration_token github_actions_registration_token}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsRegistrationToken(Construct Scope, string Id, DataGithubActionsRegistrationTokenConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubActionsRegistrationTokenConfig | *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:* DataGithubActionsRegistrationTokenConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubActionsRegistrationToken resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsRegistrationToken.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsRegistrationToken.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsRegistrationToken.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsRegistrationToken.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubActionsRegistrationToken resource upon running "cdktn 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 DataGithubActionsRegistrationToken to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubActionsRegistrationToken that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_registration_token#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubActionsRegistrationToken to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| ExpiresAt | double | *No description.* | +| Token | string | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `ExpiresAt`Required + +```csharp +public double ExpiresAt { get; } +``` + +- *Type:* double + +--- + +##### `Token`Required + +```csharp +public string Token { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubActionsRegistrationTokenConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsRegistrationTokenConfig { + 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 Repository, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_registration_token#repository DataGithubActionsRegistrationToken#repository}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_registration_token#id DataGithubActionsRegistrationToken#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_registration_token#repository DataGithubActionsRegistrationToken#repository}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_registration_token#id DataGithubActionsRegistrationToken#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. + +--- + + + diff --git a/docs/dataGithubActionsRegistrationToken.java.md b/docs/dataGithubActionsRegistrationToken.java.md new file mode 100644 index 000000000..116c45f06 --- /dev/null +++ b/docs/dataGithubActionsRegistrationToken.java.md @@ -0,0 +1,843 @@ +# `dataGithubActionsRegistrationToken` Submodule + +## Constructs + +### DataGithubActionsRegistrationToken + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_registration_token github_actions_registration_token}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_registration_token.DataGithubActionsRegistrationToken; + +DataGithubActionsRegistrationToken.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_registration_token#repository DataGithubActionsRegistrationToken#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_registration_token#id DataGithubActionsRegistrationToken#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_registration_token#repository DataGithubActionsRegistrationToken#repository}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_registration_token#id DataGithubActionsRegistrationToken#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubActionsRegistrationToken resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_actions_registration_token.DataGithubActionsRegistrationToken; + +DataGithubActionsRegistrationToken.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` + +```java +import io.cdktn.providers.github.data_github_actions_registration_token.DataGithubActionsRegistrationToken; + +DataGithubActionsRegistrationToken.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_actions_registration_token.DataGithubActionsRegistrationToken; + +DataGithubActionsRegistrationToken.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_actions_registration_token.DataGithubActionsRegistrationToken; + +DataGithubActionsRegistrationToken.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubActionsRegistrationToken.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubActionsRegistrationToken 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 DataGithubActionsRegistrationToken to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubActionsRegistrationToken that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_registration_token#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 DataGithubActionsRegistrationToken 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| expiresAt | java.lang.Number | *No description.* | +| token | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `expiresAt`Required + +```java +public java.lang.Number getExpiresAt(); +``` + +- *Type:* java.lang.Number + +--- + +##### `token`Required + +```java +public java.lang.String getToken(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubActionsRegistrationTokenConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_actions_registration_token.DataGithubActionsRegistrationTokenConfig; + +DataGithubActionsRegistrationTokenConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_registration_token#repository DataGithubActionsRegistrationToken#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_registration_token#id DataGithubActionsRegistrationToken#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_registration_token#repository DataGithubActionsRegistrationToken#repository}. + +--- + +##### `id`Optional + +```java +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/actions_registration_token#id DataGithubActionsRegistrationToken#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. + +--- + + + diff --git a/docs/dataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate.csharp.md b/docs/dataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate.csharp.md new file mode 100644 index 000000000..59104082a --- /dev/null +++ b/docs/dataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate.csharp.md @@ -0,0 +1,770 @@ +# `dataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate` Submodule + +## Constructs + +### DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_repository_oidc_subject_claim_customization_template github_actions_repository_oidc_subject_claim_customization_template}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate(Construct Scope, string Id, DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplateConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplateConfig | *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:* DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplateConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate resource upon running "cdktn 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 DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_repository_oidc_subject_claim_customization_template#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| IncludeClaimKeys | string[] | *No description.* | +| UseDefault | Io.Cdktn.IResolvable | *No description.* | +| IdInput | string | *No description.* | +| NameInput | string | *No description.* | +| Id | string | *No description.* | +| Name | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `IncludeClaimKeys`Required + +```csharp +public string[] IncludeClaimKeys { get; } +``` + +- *Type:* string[] + +--- + +##### `UseDefault`Required + +```csharp +public IResolvable UseDefault { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplateConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplateConfig { + 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 Name, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Name | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_repository_oidc_subject_claim_customization_template#name DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate#name}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_repository_oidc_subject_claim_customization_template#id DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Name`Required + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_repository_oidc_subject_claim_customization_template#name DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate#name}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_repository_oidc_subject_claim_customization_template#id DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate#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. + +--- + + + diff --git a/docs/dataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate.java.md b/docs/dataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate.java.md new file mode 100644 index 000000000..5b0c998cb --- /dev/null +++ b/docs/dataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate.java.md @@ -0,0 +1,843 @@ +# `dataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate` Submodule + +## Constructs + +### DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_repository_oidc_subject_claim_customization_template github_actions_repository_oidc_subject_claim_customization_template}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_repository_oidc_subject_claim_customization_template.DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate; + +DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .name(java.lang.String) +// .id(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 | *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 | *No description.* | +| name | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_repository_oidc_subject_claim_customization_template#name DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate#name}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_repository_oidc_subject_claim_customization_template#id DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `name`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_repository_oidc_subject_claim_customization_template#name DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate#name}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_repository_oidc_subject_claim_customization_template#id DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_actions_repository_oidc_subject_claim_customization_template.DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate; + +DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate.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` + +```java +import io.cdktn.providers.github.data_github_actions_repository_oidc_subject_claim_customization_template.DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate; + +DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_actions_repository_oidc_subject_claim_customization_template.DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate; + +DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_actions_repository_oidc_subject_claim_customization_template.DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate; + +DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate 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 DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_repository_oidc_subject_claim_customization_template#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 DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| includeClaimKeys | java.util.List | *No description.* | +| useDefault | io.cdktn.cdktn.IResolvable | *No description.* | +| idInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `includeClaimKeys`Required + +```java +public java.util.List getIncludeClaimKeys(); +``` + +- *Type:* java.util.List + +--- + +##### `useDefault`Required + +```java +public IResolvable getUseDefault(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplateConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_actions_repository_oidc_subject_claim_customization_template.DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplateConfig; + +DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplateConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .name(java.lang.String) +// .id(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 | *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 | *No description.* | +| name | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_repository_oidc_subject_claim_customization_template#name DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate#name}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_repository_oidc_subject_claim_customization_template#id DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `name`Required + +```java +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/actions_repository_oidc_subject_claim_customization_template#name DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate#name}. + +--- + +##### `id`Optional + +```java +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/actions_repository_oidc_subject_claim_customization_template#id DataGithubActionsRepositoryOidcSubjectClaimCustomizationTemplate#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. + +--- + + + diff --git a/docs/dataGithubActionsSecrets.csharp.md b/docs/dataGithubActionsSecrets.csharp.md new file mode 100644 index 000000000..4dd181002 --- /dev/null +++ b/docs/dataGithubActionsSecrets.csharp.md @@ -0,0 +1,1272 @@ +# `dataGithubActionsSecrets` Submodule + +## Constructs + +### DataGithubActionsSecrets + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_secrets github_actions_secrets}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsSecrets(Construct Scope, string Id, DataGithubActionsSecretsConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubActionsSecretsConfig | *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`Optional + +- *Type:* DataGithubActionsSecretsConfig + +--- + +#### 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.* | +| ResetFullName | *No description.* | +| ResetId | *No description.* | +| ResetName | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetFullName` + +```csharp +private void ResetFullName() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetName` + +```csharp +private void ResetName() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubActionsSecrets resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsSecrets.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsSecrets.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsSecrets.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsSecrets.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubActionsSecrets resource upon running "cdktn 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 DataGithubActionsSecrets to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubActionsSecrets that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_secrets#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubActionsSecrets to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Secrets | DataGithubActionsSecretsSecretsList | *No description.* | +| FullNameInput | string | *No description.* | +| IdInput | string | *No description.* | +| NameInput | string | *No description.* | +| FullName | string | *No description.* | +| Id | string | *No description.* | +| Name | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Secrets`Required + +```csharp +public DataGithubActionsSecretsSecretsList Secrets { get; } +``` + +- *Type:* DataGithubActionsSecretsSecretsList + +--- + +##### `FullNameInput`Optional + +```csharp +public string FullNameInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `FullName`Required + +```csharp +public string FullName { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubActionsSecretsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsSecretsConfig { + 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 FullName = null, + string Id = null, + string Name = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| FullName | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_secrets#full_name DataGithubActionsSecrets#full_name}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_secrets#id DataGithubActionsSecrets#id}. | +| Name | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_secrets#name DataGithubActionsSecrets#name}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `FullName`Optional + +```csharp +public string FullName { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_secrets#full_name DataGithubActionsSecrets#full_name}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_secrets#id DataGithubActionsSecrets#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. + +--- + +##### `Name`Optional + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_secrets#name DataGithubActionsSecrets#name}. + +--- + +### DataGithubActionsSecretsSecrets + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsSecretsSecrets { + +}; +``` + + +## Classes + +### DataGithubActionsSecretsSecretsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsSecretsSecretsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubActionsSecretsSecretsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubActionsSecretsSecretsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsSecretsSecretsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| CreatedAt | string | *No description.* | +| Name | string | *No description.* | +| UpdatedAt | string | *No description.* | +| InternalValue | DataGithubActionsSecretsSecrets | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubActionsSecretsSecrets InternalValue { get; } +``` + +- *Type:* DataGithubActionsSecretsSecrets + +--- + + + diff --git a/docs/dataGithubActionsSecrets.java.md b/docs/dataGithubActionsSecrets.java.md new file mode 100644 index 000000000..9ff58c7ca --- /dev/null +++ b/docs/dataGithubActionsSecrets.java.md @@ -0,0 +1,1354 @@ +# `dataGithubActionsSecrets` Submodule + +## Constructs + +### DataGithubActionsSecrets + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_secrets github_actions_secrets}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_secrets.DataGithubActionsSecrets; + +DataGithubActionsSecrets.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .fullName(java.lang.String) +// .id(java.lang.String) +// .name(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 | *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 | *No description.* | +| fullName | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_secrets#full_name DataGithubActionsSecrets#full_name}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_secrets#id DataGithubActionsSecrets#id}. | +| name | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_secrets#name DataGithubActionsSecrets#name}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `fullName`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_secrets#full_name DataGithubActionsSecrets#full_name}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_secrets#id DataGithubActionsSecrets#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. + +--- + +##### `name`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_secrets#name DataGithubActionsSecrets#name}. + +--- + +#### 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.* | +| resetFullName | *No description.* | +| resetId | *No description.* | +| resetName | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetFullName` + +```java +public void resetFullName() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetName` + +```java +public void resetName() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubActionsSecrets resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_actions_secrets.DataGithubActionsSecrets; + +DataGithubActionsSecrets.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` + +```java +import io.cdktn.providers.github.data_github_actions_secrets.DataGithubActionsSecrets; + +DataGithubActionsSecrets.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_actions_secrets.DataGithubActionsSecrets; + +DataGithubActionsSecrets.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_actions_secrets.DataGithubActionsSecrets; + +DataGithubActionsSecrets.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubActionsSecrets.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubActionsSecrets 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 DataGithubActionsSecrets to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubActionsSecrets that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_secrets#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 DataGithubActionsSecrets 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| secrets | DataGithubActionsSecretsSecretsList | *No description.* | +| fullNameInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| fullName | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `secrets`Required + +```java +public DataGithubActionsSecretsSecretsList getSecrets(); +``` + +- *Type:* DataGithubActionsSecretsSecretsList + +--- + +##### `fullNameInput`Optional + +```java +public java.lang.String getFullNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `fullName`Required + +```java +public java.lang.String getFullName(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubActionsSecretsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_actions_secrets.DataGithubActionsSecretsConfig; + +DataGithubActionsSecretsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .fullName(java.lang.String) +// .id(java.lang.String) +// .name(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 | *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 | *No description.* | +| fullName | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_secrets#full_name DataGithubActionsSecrets#full_name}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_secrets#id DataGithubActionsSecrets#id}. | +| name | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_secrets#name DataGithubActionsSecrets#name}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `fullName`Optional + +```java +public java.lang.String getFullName(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_secrets#full_name DataGithubActionsSecrets#full_name}. + +--- + +##### `id`Optional + +```java +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/actions_secrets#id DataGithubActionsSecrets#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. + +--- + +##### `name`Optional + +```java +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/actions_secrets#name DataGithubActionsSecrets#name}. + +--- + +### DataGithubActionsSecretsSecrets + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_actions_secrets.DataGithubActionsSecretsSecrets; + +DataGithubActionsSecretsSecrets.builder() + .build(); +``` + + +## Classes + +### DataGithubActionsSecretsSecretsList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_secrets.DataGithubActionsSecretsSecretsList; + +new DataGithubActionsSecretsSecretsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubActionsSecretsSecretsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubActionsSecretsSecretsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_secrets.DataGithubActionsSecretsSecretsOutputReference; + +new DataGithubActionsSecretsSecretsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| createdAt | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| internalValue | DataGithubActionsSecretsSecrets | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubActionsSecretsSecrets getInternalValue(); +``` + +- *Type:* DataGithubActionsSecretsSecrets + +--- + + + diff --git a/docs/dataGithubActionsVariables.csharp.md b/docs/dataGithubActionsVariables.csharp.md new file mode 100644 index 000000000..4ed542f48 --- /dev/null +++ b/docs/dataGithubActionsVariables.csharp.md @@ -0,0 +1,1283 @@ +# `dataGithubActionsVariables` Submodule + +## Constructs + +### DataGithubActionsVariables + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_variables github_actions_variables}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsVariables(Construct Scope, string Id, DataGithubActionsVariablesConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubActionsVariablesConfig | *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`Optional + +- *Type:* DataGithubActionsVariablesConfig + +--- + +#### 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.* | +| ResetFullName | *No description.* | +| ResetId | *No description.* | +| ResetName | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetFullName` + +```csharp +private void ResetFullName() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetName` + +```csharp +private void ResetName() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubActionsVariables resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsVariables.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsVariables.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsVariables.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubActionsVariables.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubActionsVariables resource upon running "cdktn 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 DataGithubActionsVariables to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubActionsVariables that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_variables#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubActionsVariables to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Variables | DataGithubActionsVariablesVariablesList | *No description.* | +| FullNameInput | string | *No description.* | +| IdInput | string | *No description.* | +| NameInput | string | *No description.* | +| FullName | string | *No description.* | +| Id | string | *No description.* | +| Name | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Variables`Required + +```csharp +public DataGithubActionsVariablesVariablesList Variables { get; } +``` + +- *Type:* DataGithubActionsVariablesVariablesList + +--- + +##### `FullNameInput`Optional + +```csharp +public string FullNameInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `FullName`Required + +```csharp +public string FullName { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubActionsVariablesConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsVariablesConfig { + 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 FullName = null, + string Id = null, + string Name = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| FullName | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_variables#full_name DataGithubActionsVariables#full_name}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_variables#id DataGithubActionsVariables#id}. | +| Name | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_variables#name DataGithubActionsVariables#name}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `FullName`Optional + +```csharp +public string FullName { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_variables#full_name DataGithubActionsVariables#full_name}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_variables#id DataGithubActionsVariables#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. + +--- + +##### `Name`Optional + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_variables#name DataGithubActionsVariables#name}. + +--- + +### DataGithubActionsVariablesVariables + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsVariablesVariables { + +}; +``` + + +## Classes + +### DataGithubActionsVariablesVariablesList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsVariablesVariablesList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubActionsVariablesVariablesOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubActionsVariablesVariablesOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubActionsVariablesVariablesOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| CreatedAt | string | *No description.* | +| Name | string | *No description.* | +| UpdatedAt | string | *No description.* | +| Value | string | *No description.* | +| InternalValue | DataGithubActionsVariablesVariables | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Value`Required + +```csharp +public string Value { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubActionsVariablesVariables InternalValue { get; } +``` + +- *Type:* DataGithubActionsVariablesVariables + +--- + + + diff --git a/docs/dataGithubActionsVariables.java.md b/docs/dataGithubActionsVariables.java.md new file mode 100644 index 000000000..79fcacce7 --- /dev/null +++ b/docs/dataGithubActionsVariables.java.md @@ -0,0 +1,1365 @@ +# `dataGithubActionsVariables` Submodule + +## Constructs + +### DataGithubActionsVariables + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_variables github_actions_variables}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_variables.DataGithubActionsVariables; + +DataGithubActionsVariables.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .fullName(java.lang.String) +// .id(java.lang.String) +// .name(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 | *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 | *No description.* | +| fullName | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_variables#full_name DataGithubActionsVariables#full_name}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_variables#id DataGithubActionsVariables#id}. | +| name | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_variables#name DataGithubActionsVariables#name}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `fullName`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_variables#full_name DataGithubActionsVariables#full_name}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_variables#id DataGithubActionsVariables#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. + +--- + +##### `name`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_variables#name DataGithubActionsVariables#name}. + +--- + +#### 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.* | +| resetFullName | *No description.* | +| resetId | *No description.* | +| resetName | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetFullName` + +```java +public void resetFullName() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetName` + +```java +public void resetName() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubActionsVariables resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_actions_variables.DataGithubActionsVariables; + +DataGithubActionsVariables.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` + +```java +import io.cdktn.providers.github.data_github_actions_variables.DataGithubActionsVariables; + +DataGithubActionsVariables.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_actions_variables.DataGithubActionsVariables; + +DataGithubActionsVariables.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_actions_variables.DataGithubActionsVariables; + +DataGithubActionsVariables.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubActionsVariables.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubActionsVariables 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 DataGithubActionsVariables to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubActionsVariables that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_variables#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 DataGithubActionsVariables 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| variables | DataGithubActionsVariablesVariablesList | *No description.* | +| fullNameInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| fullName | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `variables`Required + +```java +public DataGithubActionsVariablesVariablesList getVariables(); +``` + +- *Type:* DataGithubActionsVariablesVariablesList + +--- + +##### `fullNameInput`Optional + +```java +public java.lang.String getFullNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `fullName`Required + +```java +public java.lang.String getFullName(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubActionsVariablesConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_actions_variables.DataGithubActionsVariablesConfig; + +DataGithubActionsVariablesConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .fullName(java.lang.String) +// .id(java.lang.String) +// .name(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 | *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 | *No description.* | +| fullName | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_variables#full_name DataGithubActionsVariables#full_name}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_variables#id DataGithubActionsVariables#id}. | +| name | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_variables#name DataGithubActionsVariables#name}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `fullName`Optional + +```java +public java.lang.String getFullName(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/actions_variables#full_name DataGithubActionsVariables#full_name}. + +--- + +##### `id`Optional + +```java +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/actions_variables#id DataGithubActionsVariables#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. + +--- + +##### `name`Optional + +```java +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/actions_variables#name DataGithubActionsVariables#name}. + +--- + +### DataGithubActionsVariablesVariables + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_actions_variables.DataGithubActionsVariablesVariables; + +DataGithubActionsVariablesVariables.builder() + .build(); +``` + + +## Classes + +### DataGithubActionsVariablesVariablesList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_variables.DataGithubActionsVariablesVariablesList; + +new DataGithubActionsVariablesVariablesList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubActionsVariablesVariablesOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubActionsVariablesVariablesOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_actions_variables.DataGithubActionsVariablesVariablesOutputReference; + +new DataGithubActionsVariablesVariablesOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| createdAt | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| value | java.lang.String | *No description.* | +| internalValue | DataGithubActionsVariablesVariables | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `value`Required + +```java +public java.lang.String getValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubActionsVariablesVariables getInternalValue(); +``` + +- *Type:* DataGithubActionsVariablesVariables + +--- + + + diff --git a/docs/dataGithubApp.csharp.md b/docs/dataGithubApp.csharp.md new file mode 100644 index 000000000..1e00c2e8b --- /dev/null +++ b/docs/dataGithubApp.csharp.md @@ -0,0 +1,781 @@ +# `dataGithubApp` Submodule + +## Constructs + +### DataGithubApp + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app github_app}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubApp(Construct Scope, string Id, DataGithubAppConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubAppConfig | *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:* DataGithubAppConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubApp resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubApp.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubApp.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubApp.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubApp.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubApp resource upon running "cdktn 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 DataGithubApp to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubApp that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubApp to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Description | string | *No description.* | +| Name | string | *No description.* | +| NodeId | string | *No description.* | +| IdInput | string | *No description.* | +| SlugInput | string | *No description.* | +| Id | string | *No description.* | +| Slug | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `NodeId`Required + +```csharp +public string NodeId { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `SlugInput`Optional + +```csharp +public string SlugInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Slug`Required + +```csharp +public string Slug { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubAppConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubAppConfig { + 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 Slug, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Slug | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app#slug DataGithubApp#slug}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app#id DataGithubApp#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Slug`Required + +```csharp +public string Slug { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app#slug DataGithubApp#slug}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app#id DataGithubApp#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. + +--- + + + diff --git a/docs/dataGithubApp.java.md b/docs/dataGithubApp.java.md new file mode 100644 index 000000000..9c6ec590e --- /dev/null +++ b/docs/dataGithubApp.java.md @@ -0,0 +1,854 @@ +# `dataGithubApp` Submodule + +## Constructs + +### DataGithubApp + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app github_app}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_app.DataGithubApp; + +DataGithubApp.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .slug(java.lang.String) +// .id(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 | *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 | *No description.* | +| slug | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app#slug DataGithubApp#slug}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app#id DataGithubApp#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `slug`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app#slug DataGithubApp#slug}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app#id DataGithubApp#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubApp resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_app.DataGithubApp; + +DataGithubApp.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` + +```java +import io.cdktn.providers.github.data_github_app.DataGithubApp; + +DataGithubApp.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_app.DataGithubApp; + +DataGithubApp.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_app.DataGithubApp; + +DataGithubApp.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubApp.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubApp 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 DataGithubApp to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubApp that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app#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 DataGithubApp 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| description | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| nodeId | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| slugInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| slug | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `nodeId`Required + +```java +public java.lang.String getNodeId(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `slugInput`Optional + +```java +public java.lang.String getSlugInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `slug`Required + +```java +public java.lang.String getSlug(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubAppConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_app.DataGithubAppConfig; + +DataGithubAppConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .slug(java.lang.String) +// .id(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 | *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 | *No description.* | +| slug | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app#slug DataGithubApp#slug}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app#id DataGithubApp#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `slug`Required + +```java +public java.lang.String getSlug(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app#slug DataGithubApp#slug}. + +--- + +##### `id`Optional + +```java +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/app#id DataGithubApp#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. + +--- + + + diff --git a/docs/dataGithubAppToken.csharp.md b/docs/dataGithubAppToken.csharp.md new file mode 100644 index 000000000..2945586d5 --- /dev/null +++ b/docs/dataGithubAppToken.csharp.md @@ -0,0 +1,837 @@ +# `dataGithubAppToken` Submodule + +## Constructs + +### DataGithubAppToken + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app_token github_app_token}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubAppToken(Construct Scope, string Id, DataGithubAppTokenConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubAppTokenConfig | *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:* DataGithubAppTokenConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubAppToken resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubAppToken.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubAppToken.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubAppToken.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubAppToken.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubAppToken resource upon running "cdktn 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 DataGithubAppToken to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubAppToken that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app_token#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubAppToken to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Token | string | *No description.* | +| AppIdInput | string | *No description.* | +| IdInput | string | *No description.* | +| InstallationIdInput | string | *No description.* | +| PemFileInput | string | *No description.* | +| AppId | string | *No description.* | +| Id | string | *No description.* | +| InstallationId | string | *No description.* | +| PemFile | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Token`Required + +```csharp +public string Token { get; } +``` + +- *Type:* string + +--- + +##### `AppIdInput`Optional + +```csharp +public string AppIdInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `InstallationIdInput`Optional + +```csharp +public string InstallationIdInput { get; } +``` + +- *Type:* string + +--- + +##### `PemFileInput`Optional + +```csharp +public string PemFileInput { get; } +``` + +- *Type:* string + +--- + +##### `AppId`Required + +```csharp +public string AppId { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `InstallationId`Required + +```csharp +public string InstallationId { get; } +``` + +- *Type:* string + +--- + +##### `PemFile`Required + +```csharp +public string PemFile { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubAppTokenConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubAppTokenConfig { + 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 AppId, + string InstallationId, + string PemFile, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| AppId | string | The GitHub App ID. | +| InstallationId | string | The GitHub App installation instance ID. | +| PemFile | string | The GitHub App PEM file contents. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app_token#id DataGithubAppToken#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `AppId`Required + +```csharp +public string AppId { get; set; } +``` + +- *Type:* string + +The GitHub App ID. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app_token#app_id DataGithubAppToken#app_id} + +--- + +##### `InstallationId`Required + +```csharp +public string InstallationId { get; set; } +``` + +- *Type:* string + +The GitHub App installation instance ID. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app_token#installation_id DataGithubAppToken#installation_id} + +--- + +##### `PemFile`Required + +```csharp +public string PemFile { get; set; } +``` + +- *Type:* string + +The GitHub App PEM file contents. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app_token#pem_file DataGithubAppToken#pem_file} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app_token#id DataGithubAppToken#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. + +--- + + + diff --git a/docs/dataGithubAppToken.java.md b/docs/dataGithubAppToken.java.md new file mode 100644 index 000000000..b30737f4e --- /dev/null +++ b/docs/dataGithubAppToken.java.md @@ -0,0 +1,936 @@ +# `dataGithubAppToken` Submodule + +## Constructs + +### DataGithubAppToken + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app_token github_app_token}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_app_token.DataGithubAppToken; + +DataGithubAppToken.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .appId(java.lang.String) + .installationId(java.lang.String) + .pemFile(java.lang.String) +// .id(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 | *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 | *No description.* | +| appId | java.lang.String | The GitHub App ID. | +| installationId | java.lang.String | The GitHub App installation instance ID. | +| pemFile | java.lang.String | The GitHub App PEM file contents. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app_token#id DataGithubAppToken#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `appId`Required + +- *Type:* java.lang.String + +The GitHub App ID. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app_token#app_id DataGithubAppToken#app_id} + +--- + +##### `installationId`Required + +- *Type:* java.lang.String + +The GitHub App installation instance ID. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app_token#installation_id DataGithubAppToken#installation_id} + +--- + +##### `pemFile`Required + +- *Type:* java.lang.String + +The GitHub App PEM file contents. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app_token#pem_file DataGithubAppToken#pem_file} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app_token#id DataGithubAppToken#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubAppToken resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_app_token.DataGithubAppToken; + +DataGithubAppToken.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` + +```java +import io.cdktn.providers.github.data_github_app_token.DataGithubAppToken; + +DataGithubAppToken.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_app_token.DataGithubAppToken; + +DataGithubAppToken.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_app_token.DataGithubAppToken; + +DataGithubAppToken.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubAppToken.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubAppToken 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 DataGithubAppToken to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubAppToken that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app_token#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 DataGithubAppToken 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| token | java.lang.String | *No description.* | +| appIdInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| installationIdInput | java.lang.String | *No description.* | +| pemFileInput | java.lang.String | *No description.* | +| appId | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| installationId | java.lang.String | *No description.* | +| pemFile | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `token`Required + +```java +public java.lang.String getToken(); +``` + +- *Type:* java.lang.String + +--- + +##### `appIdInput`Optional + +```java +public java.lang.String getAppIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `installationIdInput`Optional + +```java +public java.lang.String getInstallationIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `pemFileInput`Optional + +```java +public java.lang.String getPemFileInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `appId`Required + +```java +public java.lang.String getAppId(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `installationId`Required + +```java +public java.lang.String getInstallationId(); +``` + +- *Type:* java.lang.String + +--- + +##### `pemFile`Required + +```java +public java.lang.String getPemFile(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubAppTokenConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_app_token.DataGithubAppTokenConfig; + +DataGithubAppTokenConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .appId(java.lang.String) + .installationId(java.lang.String) + .pemFile(java.lang.String) +// .id(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 | *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 | *No description.* | +| appId | java.lang.String | The GitHub App ID. | +| installationId | java.lang.String | The GitHub App installation instance ID. | +| pemFile | java.lang.String | The GitHub App PEM file contents. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app_token#id DataGithubAppToken#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `appId`Required + +```java +public java.lang.String getAppId(); +``` + +- *Type:* java.lang.String + +The GitHub App ID. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app_token#app_id DataGithubAppToken#app_id} + +--- + +##### `installationId`Required + +```java +public java.lang.String getInstallationId(); +``` + +- *Type:* java.lang.String + +The GitHub App installation instance ID. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app_token#installation_id DataGithubAppToken#installation_id} + +--- + +##### `pemFile`Required + +```java +public java.lang.String getPemFile(); +``` + +- *Type:* java.lang.String + +The GitHub App PEM file contents. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/app_token#pem_file DataGithubAppToken#pem_file} + +--- + +##### `id`Optional + +```java +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/app_token#id DataGithubAppToken#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. + +--- + + + diff --git a/docs/dataGithubBranch.csharp.md b/docs/dataGithubBranch.csharp.md new file mode 100644 index 000000000..40a2ecc08 --- /dev/null +++ b/docs/dataGithubBranch.csharp.md @@ -0,0 +1,817 @@ +# `dataGithubBranch` Submodule + +## Constructs + +### DataGithubBranch + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch github_branch}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubBranch(Construct Scope, string Id, DataGithubBranchConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubBranchConfig | *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:* DataGithubBranchConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubBranch resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubBranch.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubBranch.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubBranch.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubBranch.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubBranch resource upon running "cdktn 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 DataGithubBranch to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubBranch that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubBranch to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Etag | string | *No description.* | +| Ref | string | *No description.* | +| Sha | string | *No description.* | +| BranchInput | string | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Branch | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `Ref`Required + +```csharp +public string Ref { get; } +``` + +- *Type:* string + +--- + +##### `Sha`Required + +```csharp +public string Sha { get; } +``` + +- *Type:* string + +--- + +##### `BranchInput`Optional + +```csharp +public string BranchInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Branch`Required + +```csharp +public string Branch { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubBranchConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubBranchConfig { + 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 Branch, + string Repository, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Branch | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch#branch DataGithubBranch#branch}. | +| Repository | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch#repository DataGithubBranch#repository}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch#id DataGithubBranch#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Branch`Required + +```csharp +public string Branch { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch#branch DataGithubBranch#branch}. + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch#repository DataGithubBranch#repository}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch#id DataGithubBranch#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. + +--- + + + diff --git a/docs/dataGithubBranch.java.md b/docs/dataGithubBranch.java.md new file mode 100644 index 000000000..4661fea35 --- /dev/null +++ b/docs/dataGithubBranch.java.md @@ -0,0 +1,900 @@ +# `dataGithubBranch` Submodule + +## Constructs + +### DataGithubBranch + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch github_branch}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_branch.DataGithubBranch; + +DataGithubBranch.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .branch(java.lang.String) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| branch | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch#branch DataGithubBranch#branch}. | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch#repository DataGithubBranch#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch#id DataGithubBranch#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `branch`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch#branch DataGithubBranch#branch}. + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch#repository DataGithubBranch#repository}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch#id DataGithubBranch#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubBranch resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_branch.DataGithubBranch; + +DataGithubBranch.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` + +```java +import io.cdktn.providers.github.data_github_branch.DataGithubBranch; + +DataGithubBranch.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_branch.DataGithubBranch; + +DataGithubBranch.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_branch.DataGithubBranch; + +DataGithubBranch.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubBranch.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubBranch 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 DataGithubBranch to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubBranch that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch#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 DataGithubBranch 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| etag | java.lang.String | *No description.* | +| ref | java.lang.String | *No description.* | +| sha | java.lang.String | *No description.* | +| branchInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| branch | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `ref`Required + +```java +public java.lang.String getRef(); +``` + +- *Type:* java.lang.String + +--- + +##### `sha`Required + +```java +public java.lang.String getSha(); +``` + +- *Type:* java.lang.String + +--- + +##### `branchInput`Optional + +```java +public java.lang.String getBranchInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `branch`Required + +```java +public java.lang.String getBranch(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubBranchConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_branch.DataGithubBranchConfig; + +DataGithubBranchConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .branch(java.lang.String) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| branch | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch#branch DataGithubBranch#branch}. | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch#repository DataGithubBranch#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch#id DataGithubBranch#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `branch`Required + +```java +public java.lang.String getBranch(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch#branch DataGithubBranch#branch}. + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch#repository DataGithubBranch#repository}. + +--- + +##### `id`Optional + +```java +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/branch#id DataGithubBranch#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. + +--- + + + diff --git a/docs/dataGithubBranchProtectionRules.csharp.md b/docs/dataGithubBranchProtectionRules.csharp.md new file mode 100644 index 000000000..aeedf6177 --- /dev/null +++ b/docs/dataGithubBranchProtectionRules.csharp.md @@ -0,0 +1,1200 @@ +# `dataGithubBranchProtectionRules` Submodule + +## Constructs + +### DataGithubBranchProtectionRules + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch_protection_rules github_branch_protection_rules}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubBranchProtectionRules(Construct Scope, string Id, DataGithubBranchProtectionRulesConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubBranchProtectionRulesConfig | *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:* DataGithubBranchProtectionRulesConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubBranchProtectionRules resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubBranchProtectionRules.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubBranchProtectionRules.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubBranchProtectionRules.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubBranchProtectionRules.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubBranchProtectionRules resource upon running "cdktn 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 DataGithubBranchProtectionRules to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubBranchProtectionRules that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch_protection_rules#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubBranchProtectionRules to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Rules | DataGithubBranchProtectionRulesRulesList | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Rules`Required + +```csharp +public DataGithubBranchProtectionRulesRulesList Rules { get; } +``` + +- *Type:* DataGithubBranchProtectionRulesRulesList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubBranchProtectionRulesConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubBranchProtectionRulesConfig { + 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 Repository, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch_protection_rules#repository DataGithubBranchProtectionRules#repository}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch_protection_rules#id DataGithubBranchProtectionRules#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch_protection_rules#repository DataGithubBranchProtectionRules#repository}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch_protection_rules#id DataGithubBranchProtectionRules#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. + +--- + +### DataGithubBranchProtectionRulesRules + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubBranchProtectionRulesRules { + +}; +``` + + +## Classes + +### DataGithubBranchProtectionRulesRulesList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubBranchProtectionRulesRulesList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubBranchProtectionRulesRulesOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubBranchProtectionRulesRulesOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubBranchProtectionRulesRulesOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Pattern | string | *No description.* | +| InternalValue | DataGithubBranchProtectionRulesRules | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubBranchProtectionRulesRules InternalValue { get; } +``` + +- *Type:* DataGithubBranchProtectionRulesRules + +--- + + + diff --git a/docs/dataGithubBranchProtectionRules.java.md b/docs/dataGithubBranchProtectionRules.java.md new file mode 100644 index 000000000..a46a4fd2b --- /dev/null +++ b/docs/dataGithubBranchProtectionRules.java.md @@ -0,0 +1,1272 @@ +# `dataGithubBranchProtectionRules` Submodule + +## Constructs + +### DataGithubBranchProtectionRules + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch_protection_rules github_branch_protection_rules}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_branch_protection_rules.DataGithubBranchProtectionRules; + +DataGithubBranchProtectionRules.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch_protection_rules#repository DataGithubBranchProtectionRules#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch_protection_rules#id DataGithubBranchProtectionRules#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch_protection_rules#repository DataGithubBranchProtectionRules#repository}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch_protection_rules#id DataGithubBranchProtectionRules#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubBranchProtectionRules resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_branch_protection_rules.DataGithubBranchProtectionRules; + +DataGithubBranchProtectionRules.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` + +```java +import io.cdktn.providers.github.data_github_branch_protection_rules.DataGithubBranchProtectionRules; + +DataGithubBranchProtectionRules.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_branch_protection_rules.DataGithubBranchProtectionRules; + +DataGithubBranchProtectionRules.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_branch_protection_rules.DataGithubBranchProtectionRules; + +DataGithubBranchProtectionRules.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubBranchProtectionRules.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubBranchProtectionRules 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 DataGithubBranchProtectionRules to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubBranchProtectionRules that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch_protection_rules#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 DataGithubBranchProtectionRules 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| rules | DataGithubBranchProtectionRulesRulesList | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `rules`Required + +```java +public DataGithubBranchProtectionRulesRulesList getRules(); +``` + +- *Type:* DataGithubBranchProtectionRulesRulesList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubBranchProtectionRulesConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_branch_protection_rules.DataGithubBranchProtectionRulesConfig; + +DataGithubBranchProtectionRulesConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch_protection_rules#repository DataGithubBranchProtectionRules#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch_protection_rules#id DataGithubBranchProtectionRules#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/branch_protection_rules#repository DataGithubBranchProtectionRules#repository}. + +--- + +##### `id`Optional + +```java +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/branch_protection_rules#id DataGithubBranchProtectionRules#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. + +--- + +### DataGithubBranchProtectionRulesRules + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_branch_protection_rules.DataGithubBranchProtectionRulesRules; + +DataGithubBranchProtectionRulesRules.builder() + .build(); +``` + + +## Classes + +### DataGithubBranchProtectionRulesRulesList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_branch_protection_rules.DataGithubBranchProtectionRulesRulesList; + +new DataGithubBranchProtectionRulesRulesList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubBranchProtectionRulesRulesOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubBranchProtectionRulesRulesOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_branch_protection_rules.DataGithubBranchProtectionRulesRulesOutputReference; + +new DataGithubBranchProtectionRulesRulesOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| pattern | java.lang.String | *No description.* | +| internalValue | DataGithubBranchProtectionRulesRules | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubBranchProtectionRulesRules getInternalValue(); +``` + +- *Type:* DataGithubBranchProtectionRulesRules + +--- + + + diff --git a/docs/dataGithubCodespacesOrganizationPublicKey.csharp.md b/docs/dataGithubCodespacesOrganizationPublicKey.csharp.md new file mode 100644 index 000000000..12d6b369a --- /dev/null +++ b/docs/dataGithubCodespacesOrganizationPublicKey.csharp.md @@ -0,0 +1,734 @@ +# `dataGithubCodespacesOrganizationPublicKey` Submodule + +## Constructs + +### DataGithubCodespacesOrganizationPublicKey + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_organization_public_key github_codespaces_organization_public_key}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCodespacesOrganizationPublicKey(Construct Scope, string Id, DataGithubCodespacesOrganizationPublicKeyConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubCodespacesOrganizationPublicKeyConfig | *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`Optional + +- *Type:* DataGithubCodespacesOrganizationPublicKeyConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubCodespacesOrganizationPublicKey resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesOrganizationPublicKey.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesOrganizationPublicKey.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesOrganizationPublicKey.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesOrganizationPublicKey.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubCodespacesOrganizationPublicKey resource upon running "cdktn 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 DataGithubCodespacesOrganizationPublicKey to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubCodespacesOrganizationPublicKey that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_organization_public_key#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubCodespacesOrganizationPublicKey to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Key | string | *No description.* | +| KeyId | string | *No description.* | +| IdInput | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Key`Required + +```csharp +public string Key { get; } +``` + +- *Type:* string + +--- + +##### `KeyId`Required + +```csharp +public string KeyId { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubCodespacesOrganizationPublicKeyConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCodespacesOrganizationPublicKeyConfig { + 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 Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_organization_public_key#id DataGithubCodespacesOrganizationPublicKey#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_organization_public_key#id DataGithubCodespacesOrganizationPublicKey#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. + +--- + + + diff --git a/docs/dataGithubCodespacesOrganizationPublicKey.java.md b/docs/dataGithubCodespacesOrganizationPublicKey.java.md new file mode 100644 index 000000000..4f7206cf5 --- /dev/null +++ b/docs/dataGithubCodespacesOrganizationPublicKey.java.md @@ -0,0 +1,797 @@ +# `dataGithubCodespacesOrganizationPublicKey` Submodule + +## Constructs + +### DataGithubCodespacesOrganizationPublicKey + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_organization_public_key github_codespaces_organization_public_key}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_codespaces_organization_public_key.DataGithubCodespacesOrganizationPublicKey; + +DataGithubCodespacesOrganizationPublicKey.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_organization_public_key#id DataGithubCodespacesOrganizationPublicKey#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_organization_public_key#id DataGithubCodespacesOrganizationPublicKey#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubCodespacesOrganizationPublicKey resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_codespaces_organization_public_key.DataGithubCodespacesOrganizationPublicKey; + +DataGithubCodespacesOrganizationPublicKey.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` + +```java +import io.cdktn.providers.github.data_github_codespaces_organization_public_key.DataGithubCodespacesOrganizationPublicKey; + +DataGithubCodespacesOrganizationPublicKey.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_codespaces_organization_public_key.DataGithubCodespacesOrganizationPublicKey; + +DataGithubCodespacesOrganizationPublicKey.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_codespaces_organization_public_key.DataGithubCodespacesOrganizationPublicKey; + +DataGithubCodespacesOrganizationPublicKey.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubCodespacesOrganizationPublicKey.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubCodespacesOrganizationPublicKey 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 DataGithubCodespacesOrganizationPublicKey to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubCodespacesOrganizationPublicKey that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_organization_public_key#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 DataGithubCodespacesOrganizationPublicKey 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| key | java.lang.String | *No description.* | +| keyId | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `key`Required + +```java +public java.lang.String getKey(); +``` + +- *Type:* java.lang.String + +--- + +##### `keyId`Required + +```java +public java.lang.String getKeyId(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubCodespacesOrganizationPublicKeyConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_codespaces_organization_public_key.DataGithubCodespacesOrganizationPublicKeyConfig; + +DataGithubCodespacesOrganizationPublicKeyConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_organization_public_key#id DataGithubCodespacesOrganizationPublicKey#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Optional + +```java +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/codespaces_organization_public_key#id DataGithubCodespacesOrganizationPublicKey#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. + +--- + + + diff --git a/docs/dataGithubCodespacesOrganizationSecrets.csharp.md b/docs/dataGithubCodespacesOrganizationSecrets.csharp.md new file mode 100644 index 000000000..808f4a5b1 --- /dev/null +++ b/docs/dataGithubCodespacesOrganizationSecrets.csharp.md @@ -0,0 +1,1197 @@ +# `dataGithubCodespacesOrganizationSecrets` Submodule + +## Constructs + +### DataGithubCodespacesOrganizationSecrets + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_organization_secrets github_codespaces_organization_secrets}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCodespacesOrganizationSecrets(Construct Scope, string Id, DataGithubCodespacesOrganizationSecretsConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubCodespacesOrganizationSecretsConfig | *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`Optional + +- *Type:* DataGithubCodespacesOrganizationSecretsConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubCodespacesOrganizationSecrets resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesOrganizationSecrets.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesOrganizationSecrets.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesOrganizationSecrets.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesOrganizationSecrets.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubCodespacesOrganizationSecrets resource upon running "cdktn 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 DataGithubCodespacesOrganizationSecrets to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubCodespacesOrganizationSecrets that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_organization_secrets#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubCodespacesOrganizationSecrets to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Secrets | DataGithubCodespacesOrganizationSecretsSecretsList | *No description.* | +| IdInput | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Secrets`Required + +```csharp +public DataGithubCodespacesOrganizationSecretsSecretsList Secrets { get; } +``` + +- *Type:* DataGithubCodespacesOrganizationSecretsSecretsList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubCodespacesOrganizationSecretsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCodespacesOrganizationSecretsConfig { + 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 Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_organization_secrets#id DataGithubCodespacesOrganizationSecrets#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_organization_secrets#id DataGithubCodespacesOrganizationSecrets#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. + +--- + +### DataGithubCodespacesOrganizationSecretsSecrets + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCodespacesOrganizationSecretsSecrets { + +}; +``` + + +## Classes + +### DataGithubCodespacesOrganizationSecretsSecretsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCodespacesOrganizationSecretsSecretsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubCodespacesOrganizationSecretsSecretsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubCodespacesOrganizationSecretsSecretsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCodespacesOrganizationSecretsSecretsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| CreatedAt | string | *No description.* | +| Name | string | *No description.* | +| UpdatedAt | string | *No description.* | +| Visibility | string | *No description.* | +| InternalValue | DataGithubCodespacesOrganizationSecretsSecrets | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Visibility`Required + +```csharp +public string Visibility { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubCodespacesOrganizationSecretsSecrets InternalValue { get; } +``` + +- *Type:* DataGithubCodespacesOrganizationSecretsSecrets + +--- + + + diff --git a/docs/dataGithubCodespacesOrganizationSecrets.java.md b/docs/dataGithubCodespacesOrganizationSecrets.java.md new file mode 100644 index 000000000..f93564780 --- /dev/null +++ b/docs/dataGithubCodespacesOrganizationSecrets.java.md @@ -0,0 +1,1259 @@ +# `dataGithubCodespacesOrganizationSecrets` Submodule + +## Constructs + +### DataGithubCodespacesOrganizationSecrets + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_organization_secrets github_codespaces_organization_secrets}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_codespaces_organization_secrets.DataGithubCodespacesOrganizationSecrets; + +DataGithubCodespacesOrganizationSecrets.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_organization_secrets#id DataGithubCodespacesOrganizationSecrets#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_organization_secrets#id DataGithubCodespacesOrganizationSecrets#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubCodespacesOrganizationSecrets resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_codespaces_organization_secrets.DataGithubCodespacesOrganizationSecrets; + +DataGithubCodespacesOrganizationSecrets.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` + +```java +import io.cdktn.providers.github.data_github_codespaces_organization_secrets.DataGithubCodespacesOrganizationSecrets; + +DataGithubCodespacesOrganizationSecrets.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_codespaces_organization_secrets.DataGithubCodespacesOrganizationSecrets; + +DataGithubCodespacesOrganizationSecrets.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_codespaces_organization_secrets.DataGithubCodespacesOrganizationSecrets; + +DataGithubCodespacesOrganizationSecrets.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubCodespacesOrganizationSecrets.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubCodespacesOrganizationSecrets 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 DataGithubCodespacesOrganizationSecrets to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubCodespacesOrganizationSecrets that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_organization_secrets#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 DataGithubCodespacesOrganizationSecrets 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| secrets | DataGithubCodespacesOrganizationSecretsSecretsList | *No description.* | +| idInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `secrets`Required + +```java +public DataGithubCodespacesOrganizationSecretsSecretsList getSecrets(); +``` + +- *Type:* DataGithubCodespacesOrganizationSecretsSecretsList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubCodespacesOrganizationSecretsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_codespaces_organization_secrets.DataGithubCodespacesOrganizationSecretsConfig; + +DataGithubCodespacesOrganizationSecretsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_organization_secrets#id DataGithubCodespacesOrganizationSecrets#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Optional + +```java +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/codespaces_organization_secrets#id DataGithubCodespacesOrganizationSecrets#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. + +--- + +### DataGithubCodespacesOrganizationSecretsSecrets + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_codespaces_organization_secrets.DataGithubCodespacesOrganizationSecretsSecrets; + +DataGithubCodespacesOrganizationSecretsSecrets.builder() + .build(); +``` + + +## Classes + +### DataGithubCodespacesOrganizationSecretsSecretsList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_codespaces_organization_secrets.DataGithubCodespacesOrganizationSecretsSecretsList; + +new DataGithubCodespacesOrganizationSecretsSecretsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubCodespacesOrganizationSecretsSecretsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubCodespacesOrganizationSecretsSecretsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_codespaces_organization_secrets.DataGithubCodespacesOrganizationSecretsSecretsOutputReference; + +new DataGithubCodespacesOrganizationSecretsSecretsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| createdAt | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| visibility | java.lang.String | *No description.* | +| internalValue | DataGithubCodespacesOrganizationSecretsSecrets | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `visibility`Required + +```java +public java.lang.String getVisibility(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubCodespacesOrganizationSecretsSecrets getInternalValue(); +``` + +- *Type:* DataGithubCodespacesOrganizationSecretsSecrets + +--- + + + diff --git a/docs/dataGithubCodespacesPublicKey.csharp.md b/docs/dataGithubCodespacesPublicKey.csharp.md new file mode 100644 index 000000000..ddea5a209 --- /dev/null +++ b/docs/dataGithubCodespacesPublicKey.csharp.md @@ -0,0 +1,770 @@ +# `dataGithubCodespacesPublicKey` Submodule + +## Constructs + +### DataGithubCodespacesPublicKey + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_public_key github_codespaces_public_key}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCodespacesPublicKey(Construct Scope, string Id, DataGithubCodespacesPublicKeyConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubCodespacesPublicKeyConfig | *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:* DataGithubCodespacesPublicKeyConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubCodespacesPublicKey resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesPublicKey.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesPublicKey.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesPublicKey.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesPublicKey.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubCodespacesPublicKey resource upon running "cdktn 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 DataGithubCodespacesPublicKey to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubCodespacesPublicKey that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_public_key#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubCodespacesPublicKey to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Key | string | *No description.* | +| KeyId | string | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Key`Required + +```csharp +public string Key { get; } +``` + +- *Type:* string + +--- + +##### `KeyId`Required + +```csharp +public string KeyId { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubCodespacesPublicKeyConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCodespacesPublicKeyConfig { + 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 Repository, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_public_key#repository DataGithubCodespacesPublicKey#repository}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_public_key#id DataGithubCodespacesPublicKey#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_public_key#repository DataGithubCodespacesPublicKey#repository}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_public_key#id DataGithubCodespacesPublicKey#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. + +--- + + + diff --git a/docs/dataGithubCodespacesPublicKey.java.md b/docs/dataGithubCodespacesPublicKey.java.md new file mode 100644 index 000000000..a1c21ca5e --- /dev/null +++ b/docs/dataGithubCodespacesPublicKey.java.md @@ -0,0 +1,843 @@ +# `dataGithubCodespacesPublicKey` Submodule + +## Constructs + +### DataGithubCodespacesPublicKey + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_public_key github_codespaces_public_key}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_codespaces_public_key.DataGithubCodespacesPublicKey; + +DataGithubCodespacesPublicKey.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_public_key#repository DataGithubCodespacesPublicKey#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_public_key#id DataGithubCodespacesPublicKey#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_public_key#repository DataGithubCodespacesPublicKey#repository}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_public_key#id DataGithubCodespacesPublicKey#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubCodespacesPublicKey resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_codespaces_public_key.DataGithubCodespacesPublicKey; + +DataGithubCodespacesPublicKey.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` + +```java +import io.cdktn.providers.github.data_github_codespaces_public_key.DataGithubCodespacesPublicKey; + +DataGithubCodespacesPublicKey.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_codespaces_public_key.DataGithubCodespacesPublicKey; + +DataGithubCodespacesPublicKey.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_codespaces_public_key.DataGithubCodespacesPublicKey; + +DataGithubCodespacesPublicKey.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubCodespacesPublicKey.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubCodespacesPublicKey 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 DataGithubCodespacesPublicKey to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubCodespacesPublicKey that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_public_key#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 DataGithubCodespacesPublicKey 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| key | java.lang.String | *No description.* | +| keyId | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `key`Required + +```java +public java.lang.String getKey(); +``` + +- *Type:* java.lang.String + +--- + +##### `keyId`Required + +```java +public java.lang.String getKeyId(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubCodespacesPublicKeyConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_codespaces_public_key.DataGithubCodespacesPublicKeyConfig; + +DataGithubCodespacesPublicKeyConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_public_key#repository DataGithubCodespacesPublicKey#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_public_key#id DataGithubCodespacesPublicKey#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_public_key#repository DataGithubCodespacesPublicKey#repository}. + +--- + +##### `id`Optional + +```java +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/codespaces_public_key#id DataGithubCodespacesPublicKey#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. + +--- + + + diff --git a/docs/dataGithubCodespacesSecrets.csharp.md b/docs/dataGithubCodespacesSecrets.csharp.md new file mode 100644 index 000000000..cef64fed3 --- /dev/null +++ b/docs/dataGithubCodespacesSecrets.csharp.md @@ -0,0 +1,1276 @@ +# `dataGithubCodespacesSecrets` Submodule + +## Constructs + +### DataGithubCodespacesSecrets + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_secrets github_codespaces_secrets}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCodespacesSecrets(Construct Scope, string Id, DataGithubCodespacesSecretsConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubCodespacesSecretsConfig | *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`Optional + +- *Type:* DataGithubCodespacesSecretsConfig + +--- + +#### 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.* | +| ResetFullName | *No description.* | +| ResetId | *No description.* | +| ResetName | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetFullName` + +```csharp +private void ResetFullName() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetName` + +```csharp +private void ResetName() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubCodespacesSecrets resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesSecrets.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesSecrets.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesSecrets.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesSecrets.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubCodespacesSecrets resource upon running "cdktn 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 DataGithubCodespacesSecrets to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubCodespacesSecrets that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_secrets#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubCodespacesSecrets to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Secrets | DataGithubCodespacesSecretsSecretsList | *No description.* | +| FullNameInput | string | *No description.* | +| IdInput | string | *No description.* | +| NameInput | string | *No description.* | +| FullName | string | *No description.* | +| Id | string | *No description.* | +| Name | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Secrets`Required + +```csharp +public DataGithubCodespacesSecretsSecretsList Secrets { get; } +``` + +- *Type:* DataGithubCodespacesSecretsSecretsList + +--- + +##### `FullNameInput`Optional + +```csharp +public string FullNameInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `FullName`Required + +```csharp +public string FullName { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubCodespacesSecretsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCodespacesSecretsConfig { + 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 FullName = null, + string Id = null, + string Name = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| FullName | string | Full name of the repository (in `org/name` format). | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_secrets#id DataGithubCodespacesSecrets#id}. | +| Name | string | The name of the repository. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `FullName`Optional + +```csharp +public string FullName { get; set; } +``` + +- *Type:* string + +Full name of the repository (in `org/name` format). + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_secrets#full_name DataGithubCodespacesSecrets#full_name} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_secrets#id DataGithubCodespacesSecrets#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. + +--- + +##### `Name`Optional + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +The name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_secrets#name DataGithubCodespacesSecrets#name} + +--- + +### DataGithubCodespacesSecretsSecrets + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCodespacesSecretsSecrets { + +}; +``` + + +## Classes + +### DataGithubCodespacesSecretsSecretsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCodespacesSecretsSecretsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubCodespacesSecretsSecretsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubCodespacesSecretsSecretsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCodespacesSecretsSecretsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| CreatedAt | string | *No description.* | +| Name | string | *No description.* | +| UpdatedAt | string | *No description.* | +| InternalValue | DataGithubCodespacesSecretsSecrets | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubCodespacesSecretsSecrets InternalValue { get; } +``` + +- *Type:* DataGithubCodespacesSecretsSecrets + +--- + + + diff --git a/docs/dataGithubCodespacesSecrets.java.md b/docs/dataGithubCodespacesSecrets.java.md new file mode 100644 index 000000000..49ad1e1ee --- /dev/null +++ b/docs/dataGithubCodespacesSecrets.java.md @@ -0,0 +1,1362 @@ +# `dataGithubCodespacesSecrets` Submodule + +## Constructs + +### DataGithubCodespacesSecrets + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_secrets github_codespaces_secrets}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_codespaces_secrets.DataGithubCodespacesSecrets; + +DataGithubCodespacesSecrets.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .fullName(java.lang.String) +// .id(java.lang.String) +// .name(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 | *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 | *No description.* | +| fullName | java.lang.String | Full name of the repository (in `org/name` format). | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_secrets#id DataGithubCodespacesSecrets#id}. | +| name | java.lang.String | The name of the repository. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `fullName`Optional + +- *Type:* java.lang.String + +Full name of the repository (in `org/name` format). + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_secrets#full_name DataGithubCodespacesSecrets#full_name} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_secrets#id DataGithubCodespacesSecrets#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. + +--- + +##### `name`Optional + +- *Type:* java.lang.String + +The name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_secrets#name DataGithubCodespacesSecrets#name} + +--- + +#### 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.* | +| resetFullName | *No description.* | +| resetId | *No description.* | +| resetName | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetFullName` + +```java +public void resetFullName() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetName` + +```java +public void resetName() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubCodespacesSecrets resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_codespaces_secrets.DataGithubCodespacesSecrets; + +DataGithubCodespacesSecrets.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` + +```java +import io.cdktn.providers.github.data_github_codespaces_secrets.DataGithubCodespacesSecrets; + +DataGithubCodespacesSecrets.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_codespaces_secrets.DataGithubCodespacesSecrets; + +DataGithubCodespacesSecrets.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_codespaces_secrets.DataGithubCodespacesSecrets; + +DataGithubCodespacesSecrets.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubCodespacesSecrets.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubCodespacesSecrets 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 DataGithubCodespacesSecrets to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubCodespacesSecrets that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_secrets#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 DataGithubCodespacesSecrets 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| secrets | DataGithubCodespacesSecretsSecretsList | *No description.* | +| fullNameInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| fullName | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `secrets`Required + +```java +public DataGithubCodespacesSecretsSecretsList getSecrets(); +``` + +- *Type:* DataGithubCodespacesSecretsSecretsList + +--- + +##### `fullNameInput`Optional + +```java +public java.lang.String getFullNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `fullName`Required + +```java +public java.lang.String getFullName(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubCodespacesSecretsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_codespaces_secrets.DataGithubCodespacesSecretsConfig; + +DataGithubCodespacesSecretsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .fullName(java.lang.String) +// .id(java.lang.String) +// .name(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 | *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 | *No description.* | +| fullName | java.lang.String | Full name of the repository (in `org/name` format). | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_secrets#id DataGithubCodespacesSecrets#id}. | +| name | java.lang.String | The name of the repository. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `fullName`Optional + +```java +public java.lang.String getFullName(); +``` + +- *Type:* java.lang.String + +Full name of the repository (in `org/name` format). + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_secrets#full_name DataGithubCodespacesSecrets#full_name} + +--- + +##### `id`Optional + +```java +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/codespaces_secrets#id DataGithubCodespacesSecrets#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. + +--- + +##### `name`Optional + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +The name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_secrets#name DataGithubCodespacesSecrets#name} + +--- + +### DataGithubCodespacesSecretsSecrets + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_codespaces_secrets.DataGithubCodespacesSecretsSecrets; + +DataGithubCodespacesSecretsSecrets.builder() + .build(); +``` + + +## Classes + +### DataGithubCodespacesSecretsSecretsList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_codespaces_secrets.DataGithubCodespacesSecretsSecretsList; + +new DataGithubCodespacesSecretsSecretsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubCodespacesSecretsSecretsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubCodespacesSecretsSecretsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_codespaces_secrets.DataGithubCodespacesSecretsSecretsOutputReference; + +new DataGithubCodespacesSecretsSecretsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| createdAt | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| internalValue | DataGithubCodespacesSecretsSecrets | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubCodespacesSecretsSecrets getInternalValue(); +``` + +- *Type:* DataGithubCodespacesSecretsSecrets + +--- + + + diff --git a/docs/dataGithubCodespacesUserPublicKey.csharp.md b/docs/dataGithubCodespacesUserPublicKey.csharp.md new file mode 100644 index 000000000..83b9f70fc --- /dev/null +++ b/docs/dataGithubCodespacesUserPublicKey.csharp.md @@ -0,0 +1,734 @@ +# `dataGithubCodespacesUserPublicKey` Submodule + +## Constructs + +### DataGithubCodespacesUserPublicKey + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_user_public_key github_codespaces_user_public_key}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCodespacesUserPublicKey(Construct Scope, string Id, DataGithubCodespacesUserPublicKeyConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubCodespacesUserPublicKeyConfig | *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`Optional + +- *Type:* DataGithubCodespacesUserPublicKeyConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubCodespacesUserPublicKey resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesUserPublicKey.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesUserPublicKey.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesUserPublicKey.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesUserPublicKey.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubCodespacesUserPublicKey resource upon running "cdktn 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 DataGithubCodespacesUserPublicKey to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubCodespacesUserPublicKey that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_user_public_key#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubCodespacesUserPublicKey to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Key | string | *No description.* | +| KeyId | string | *No description.* | +| IdInput | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Key`Required + +```csharp +public string Key { get; } +``` + +- *Type:* string + +--- + +##### `KeyId`Required + +```csharp +public string KeyId { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubCodespacesUserPublicKeyConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCodespacesUserPublicKeyConfig { + 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 Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_user_public_key#id DataGithubCodespacesUserPublicKey#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_user_public_key#id DataGithubCodespacesUserPublicKey#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. + +--- + + + diff --git a/docs/dataGithubCodespacesUserPublicKey.java.md b/docs/dataGithubCodespacesUserPublicKey.java.md new file mode 100644 index 000000000..ebedb1221 --- /dev/null +++ b/docs/dataGithubCodespacesUserPublicKey.java.md @@ -0,0 +1,797 @@ +# `dataGithubCodespacesUserPublicKey` Submodule + +## Constructs + +### DataGithubCodespacesUserPublicKey + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_user_public_key github_codespaces_user_public_key}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_codespaces_user_public_key.DataGithubCodespacesUserPublicKey; + +DataGithubCodespacesUserPublicKey.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_user_public_key#id DataGithubCodespacesUserPublicKey#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_user_public_key#id DataGithubCodespacesUserPublicKey#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubCodespacesUserPublicKey resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_codespaces_user_public_key.DataGithubCodespacesUserPublicKey; + +DataGithubCodespacesUserPublicKey.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` + +```java +import io.cdktn.providers.github.data_github_codespaces_user_public_key.DataGithubCodespacesUserPublicKey; + +DataGithubCodespacesUserPublicKey.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_codespaces_user_public_key.DataGithubCodespacesUserPublicKey; + +DataGithubCodespacesUserPublicKey.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_codespaces_user_public_key.DataGithubCodespacesUserPublicKey; + +DataGithubCodespacesUserPublicKey.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubCodespacesUserPublicKey.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubCodespacesUserPublicKey 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 DataGithubCodespacesUserPublicKey to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubCodespacesUserPublicKey that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_user_public_key#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 DataGithubCodespacesUserPublicKey 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| key | java.lang.String | *No description.* | +| keyId | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `key`Required + +```java +public java.lang.String getKey(); +``` + +- *Type:* java.lang.String + +--- + +##### `keyId`Required + +```java +public java.lang.String getKeyId(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubCodespacesUserPublicKeyConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_codespaces_user_public_key.DataGithubCodespacesUserPublicKeyConfig; + +DataGithubCodespacesUserPublicKeyConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_user_public_key#id DataGithubCodespacesUserPublicKey#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Optional + +```java +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/codespaces_user_public_key#id DataGithubCodespacesUserPublicKey#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. + +--- + + + diff --git a/docs/dataGithubCodespacesUserSecrets.csharp.md b/docs/dataGithubCodespacesUserSecrets.csharp.md new file mode 100644 index 000000000..3c14f2912 --- /dev/null +++ b/docs/dataGithubCodespacesUserSecrets.csharp.md @@ -0,0 +1,1197 @@ +# `dataGithubCodespacesUserSecrets` Submodule + +## Constructs + +### DataGithubCodespacesUserSecrets + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_user_secrets github_codespaces_user_secrets}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCodespacesUserSecrets(Construct Scope, string Id, DataGithubCodespacesUserSecretsConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubCodespacesUserSecretsConfig | *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`Optional + +- *Type:* DataGithubCodespacesUserSecretsConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubCodespacesUserSecrets resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesUserSecrets.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesUserSecrets.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesUserSecrets.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCodespacesUserSecrets.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubCodespacesUserSecrets resource upon running "cdktn 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 DataGithubCodespacesUserSecrets to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubCodespacesUserSecrets that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_user_secrets#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubCodespacesUserSecrets to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Secrets | DataGithubCodespacesUserSecretsSecretsList | *No description.* | +| IdInput | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Secrets`Required + +```csharp +public DataGithubCodespacesUserSecretsSecretsList Secrets { get; } +``` + +- *Type:* DataGithubCodespacesUserSecretsSecretsList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubCodespacesUserSecretsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCodespacesUserSecretsConfig { + 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 Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_user_secrets#id DataGithubCodespacesUserSecrets#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_user_secrets#id DataGithubCodespacesUserSecrets#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. + +--- + +### DataGithubCodespacesUserSecretsSecrets + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCodespacesUserSecretsSecrets { + +}; +``` + + +## Classes + +### DataGithubCodespacesUserSecretsSecretsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCodespacesUserSecretsSecretsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubCodespacesUserSecretsSecretsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubCodespacesUserSecretsSecretsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCodespacesUserSecretsSecretsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| CreatedAt | string | *No description.* | +| Name | string | *No description.* | +| UpdatedAt | string | *No description.* | +| Visibility | string | *No description.* | +| InternalValue | DataGithubCodespacesUserSecretsSecrets | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Visibility`Required + +```csharp +public string Visibility { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubCodespacesUserSecretsSecrets InternalValue { get; } +``` + +- *Type:* DataGithubCodespacesUserSecretsSecrets + +--- + + + diff --git a/docs/dataGithubCodespacesUserSecrets.java.md b/docs/dataGithubCodespacesUserSecrets.java.md new file mode 100644 index 000000000..e82bcfa4d --- /dev/null +++ b/docs/dataGithubCodespacesUserSecrets.java.md @@ -0,0 +1,1259 @@ +# `dataGithubCodespacesUserSecrets` Submodule + +## Constructs + +### DataGithubCodespacesUserSecrets + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_user_secrets github_codespaces_user_secrets}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_codespaces_user_secrets.DataGithubCodespacesUserSecrets; + +DataGithubCodespacesUserSecrets.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_user_secrets#id DataGithubCodespacesUserSecrets#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_user_secrets#id DataGithubCodespacesUserSecrets#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubCodespacesUserSecrets resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_codespaces_user_secrets.DataGithubCodespacesUserSecrets; + +DataGithubCodespacesUserSecrets.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` + +```java +import io.cdktn.providers.github.data_github_codespaces_user_secrets.DataGithubCodespacesUserSecrets; + +DataGithubCodespacesUserSecrets.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_codespaces_user_secrets.DataGithubCodespacesUserSecrets; + +DataGithubCodespacesUserSecrets.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_codespaces_user_secrets.DataGithubCodespacesUserSecrets; + +DataGithubCodespacesUserSecrets.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubCodespacesUserSecrets.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubCodespacesUserSecrets 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 DataGithubCodespacesUserSecrets to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubCodespacesUserSecrets that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_user_secrets#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 DataGithubCodespacesUserSecrets 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| secrets | DataGithubCodespacesUserSecretsSecretsList | *No description.* | +| idInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `secrets`Required + +```java +public DataGithubCodespacesUserSecretsSecretsList getSecrets(); +``` + +- *Type:* DataGithubCodespacesUserSecretsSecretsList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubCodespacesUserSecretsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_codespaces_user_secrets.DataGithubCodespacesUserSecretsConfig; + +DataGithubCodespacesUserSecretsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/codespaces_user_secrets#id DataGithubCodespacesUserSecrets#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Optional + +```java +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/codespaces_user_secrets#id DataGithubCodespacesUserSecrets#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. + +--- + +### DataGithubCodespacesUserSecretsSecrets + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_codespaces_user_secrets.DataGithubCodespacesUserSecretsSecrets; + +DataGithubCodespacesUserSecretsSecrets.builder() + .build(); +``` + + +## Classes + +### DataGithubCodespacesUserSecretsSecretsList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_codespaces_user_secrets.DataGithubCodespacesUserSecretsSecretsList; + +new DataGithubCodespacesUserSecretsSecretsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubCodespacesUserSecretsSecretsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubCodespacesUserSecretsSecretsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_codespaces_user_secrets.DataGithubCodespacesUserSecretsSecretsOutputReference; + +new DataGithubCodespacesUserSecretsSecretsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| createdAt | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| visibility | java.lang.String | *No description.* | +| internalValue | DataGithubCodespacesUserSecretsSecrets | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `visibility`Required + +```java +public java.lang.String getVisibility(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubCodespacesUserSecretsSecrets getInternalValue(); +``` + +- *Type:* DataGithubCodespacesUserSecretsSecrets + +--- + + + diff --git a/docs/dataGithubCollaborators.csharp.md b/docs/dataGithubCollaborators.csharp.md new file mode 100644 index 000000000..d83f61371 --- /dev/null +++ b/docs/dataGithubCollaborators.csharp.md @@ -0,0 +1,1487 @@ +# `dataGithubCollaborators` Submodule + +## Constructs + +### DataGithubCollaborators + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators github_collaborators}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCollaborators(Construct Scope, string Id, DataGithubCollaboratorsConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubCollaboratorsConfig | *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:* DataGithubCollaboratorsConfig + +--- + +#### 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.* | +| ResetAffiliation | *No description.* | +| ResetId | *No description.* | +| ResetPermission | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetAffiliation` + +```csharp +private void ResetAffiliation() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetPermission` + +```csharp +private void ResetPermission() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubCollaborators resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCollaborators.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCollaborators.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCollaborators.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubCollaborators.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubCollaborators resource upon running "cdktn 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 DataGithubCollaborators to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubCollaborators that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubCollaborators to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Collaborator | DataGithubCollaboratorsCollaboratorList | *No description.* | +| AffiliationInput | string | *No description.* | +| IdInput | string | *No description.* | +| OwnerInput | string | *No description.* | +| PermissionInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Affiliation | string | *No description.* | +| Id | string | *No description.* | +| Owner | string | *No description.* | +| Permission | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Collaborator`Required + +```csharp +public DataGithubCollaboratorsCollaboratorList Collaborator { get; } +``` + +- *Type:* DataGithubCollaboratorsCollaboratorList + +--- + +##### `AffiliationInput`Optional + +```csharp +public string AffiliationInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `OwnerInput`Optional + +```csharp +public string OwnerInput { get; } +``` + +- *Type:* string + +--- + +##### `PermissionInput`Optional + +```csharp +public string PermissionInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Affiliation`Required + +```csharp +public string Affiliation { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Owner`Required + +```csharp +public string Owner { get; } +``` + +- *Type:* string + +--- + +##### `Permission`Required + +```csharp +public string Permission { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubCollaboratorsCollaborator + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCollaboratorsCollaborator { + +}; +``` + + +### DataGithubCollaboratorsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCollaboratorsConfig { + 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 Owner, + string Repository, + string Affiliation = null, + string Id = null, + string Permission = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Owner | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#owner DataGithubCollaborators#owner}. | +| Repository | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#repository DataGithubCollaborators#repository}. | +| Affiliation | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#affiliation DataGithubCollaborators#affiliation}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#id DataGithubCollaborators#id}. | +| Permission | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#permission DataGithubCollaborators#permission}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Owner`Required + +```csharp +public string Owner { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#owner DataGithubCollaborators#owner}. + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#repository DataGithubCollaborators#repository}. + +--- + +##### `Affiliation`Optional + +```csharp +public string Affiliation { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#affiliation DataGithubCollaborators#affiliation}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#id DataGithubCollaborators#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. + +--- + +##### `Permission`Optional + +```csharp +public string Permission { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#permission DataGithubCollaborators#permission}. + +--- + +## Classes + +### DataGithubCollaboratorsCollaboratorList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCollaboratorsCollaboratorList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubCollaboratorsCollaboratorOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubCollaboratorsCollaboratorOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubCollaboratorsCollaboratorOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| EventsUrl | string | *No description.* | +| FollowersUrl | string | *No description.* | +| FollowingUrl | string | *No description.* | +| GistsUrl | string | *No description.* | +| HtmlUrl | string | *No description.* | +| Id | double | *No description.* | +| Login | string | *No description.* | +| OrganizationsUrl | string | *No description.* | +| Permission | string | *No description.* | +| ReceivedEventsUrl | string | *No description.* | +| ReposUrl | string | *No description.* | +| SiteAdmin | Io.Cdktn.IResolvable | *No description.* | +| StarredUrl | string | *No description.* | +| SubscriptionsUrl | string | *No description.* | +| Type | string | *No description.* | +| Url | string | *No description.* | +| InternalValue | DataGithubCollaboratorsCollaborator | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `EventsUrl`Required + +```csharp +public string EventsUrl { get; } +``` + +- *Type:* string + +--- + +##### `FollowersUrl`Required + +```csharp +public string FollowersUrl { get; } +``` + +- *Type:* string + +--- + +##### `FollowingUrl`Required + +```csharp +public string FollowingUrl { get; } +``` + +- *Type:* string + +--- + +##### `GistsUrl`Required + +```csharp +public string GistsUrl { get; } +``` + +- *Type:* string + +--- + +##### `HtmlUrl`Required + +```csharp +public string HtmlUrl { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public double Id { get; } +``` + +- *Type:* double + +--- + +##### `Login`Required + +```csharp +public string Login { get; } +``` + +- *Type:* string + +--- + +##### `OrganizationsUrl`Required + +```csharp +public string OrganizationsUrl { get; } +``` + +- *Type:* string + +--- + +##### `Permission`Required + +```csharp +public string Permission { get; } +``` + +- *Type:* string + +--- + +##### `ReceivedEventsUrl`Required + +```csharp +public string ReceivedEventsUrl { get; } +``` + +- *Type:* string + +--- + +##### `ReposUrl`Required + +```csharp +public string ReposUrl { get; } +``` + +- *Type:* string + +--- + +##### `SiteAdmin`Required + +```csharp +public IResolvable SiteAdmin { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `StarredUrl`Required + +```csharp +public string StarredUrl { get; } +``` + +- *Type:* string + +--- + +##### `SubscriptionsUrl`Required + +```csharp +public string SubscriptionsUrl { get; } +``` + +- *Type:* string + +--- + +##### `Type`Required + +```csharp +public string Type { get; } +``` + +- *Type:* string + +--- + +##### `Url`Required + +```csharp +public string Url { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubCollaboratorsCollaborator InternalValue { get; } +``` + +- *Type:* DataGithubCollaboratorsCollaborator + +--- + + + diff --git a/docs/dataGithubCollaborators.java.md b/docs/dataGithubCollaborators.java.md new file mode 100644 index 000000000..fede99c59 --- /dev/null +++ b/docs/dataGithubCollaborators.java.md @@ -0,0 +1,1589 @@ +# `dataGithubCollaborators` Submodule + +## Constructs + +### DataGithubCollaborators + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators github_collaborators}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_collaborators.DataGithubCollaborators; + +DataGithubCollaborators.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .owner(java.lang.String) + .repository(java.lang.String) +// .affiliation(java.lang.String) +// .id(java.lang.String) +// .permission(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 | *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 | *No description.* | +| owner | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#owner DataGithubCollaborators#owner}. | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#repository DataGithubCollaborators#repository}. | +| affiliation | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#affiliation DataGithubCollaborators#affiliation}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#id DataGithubCollaborators#id}. | +| permission | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#permission DataGithubCollaborators#permission}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `owner`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#owner DataGithubCollaborators#owner}. + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#repository DataGithubCollaborators#repository}. + +--- + +##### `affiliation`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#affiliation DataGithubCollaborators#affiliation}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#id DataGithubCollaborators#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. + +--- + +##### `permission`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#permission DataGithubCollaborators#permission}. + +--- + +#### 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.* | +| resetAffiliation | *No description.* | +| resetId | *No description.* | +| resetPermission | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetAffiliation` + +```java +public void resetAffiliation() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetPermission` + +```java +public void resetPermission() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubCollaborators resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_collaborators.DataGithubCollaborators; + +DataGithubCollaborators.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` + +```java +import io.cdktn.providers.github.data_github_collaborators.DataGithubCollaborators; + +DataGithubCollaborators.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_collaborators.DataGithubCollaborators; + +DataGithubCollaborators.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_collaborators.DataGithubCollaborators; + +DataGithubCollaborators.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubCollaborators.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubCollaborators 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 DataGithubCollaborators to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubCollaborators that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#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 DataGithubCollaborators 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| collaborator | DataGithubCollaboratorsCollaboratorList | *No description.* | +| affiliationInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| ownerInput | java.lang.String | *No description.* | +| permissionInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| affiliation | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| owner | java.lang.String | *No description.* | +| permission | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `collaborator`Required + +```java +public DataGithubCollaboratorsCollaboratorList getCollaborator(); +``` + +- *Type:* DataGithubCollaboratorsCollaboratorList + +--- + +##### `affiliationInput`Optional + +```java +public java.lang.String getAffiliationInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `ownerInput`Optional + +```java +public java.lang.String getOwnerInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `permissionInput`Optional + +```java +public java.lang.String getPermissionInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `affiliation`Required + +```java +public java.lang.String getAffiliation(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `owner`Required + +```java +public java.lang.String getOwner(); +``` + +- *Type:* java.lang.String + +--- + +##### `permission`Required + +```java +public java.lang.String getPermission(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubCollaboratorsCollaborator + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_collaborators.DataGithubCollaboratorsCollaborator; + +DataGithubCollaboratorsCollaborator.builder() + .build(); +``` + + +### DataGithubCollaboratorsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_collaborators.DataGithubCollaboratorsConfig; + +DataGithubCollaboratorsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .owner(java.lang.String) + .repository(java.lang.String) +// .affiliation(java.lang.String) +// .id(java.lang.String) +// .permission(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 | *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 | *No description.* | +| owner | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#owner DataGithubCollaborators#owner}. | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#repository DataGithubCollaborators#repository}. | +| affiliation | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#affiliation DataGithubCollaborators#affiliation}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#id DataGithubCollaborators#id}. | +| permission | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#permission DataGithubCollaborators#permission}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `owner`Required + +```java +public java.lang.String getOwner(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#owner DataGithubCollaborators#owner}. + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#repository DataGithubCollaborators#repository}. + +--- + +##### `affiliation`Optional + +```java +public java.lang.String getAffiliation(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#affiliation DataGithubCollaborators#affiliation}. + +--- + +##### `id`Optional + +```java +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/collaborators#id DataGithubCollaborators#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. + +--- + +##### `permission`Optional + +```java +public java.lang.String getPermission(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/collaborators#permission DataGithubCollaborators#permission}. + +--- + +## Classes + +### DataGithubCollaboratorsCollaboratorList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_collaborators.DataGithubCollaboratorsCollaboratorList; + +new DataGithubCollaboratorsCollaboratorList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubCollaboratorsCollaboratorOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubCollaboratorsCollaboratorOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_collaborators.DataGithubCollaboratorsCollaboratorOutputReference; + +new DataGithubCollaboratorsCollaboratorOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| eventsUrl | java.lang.String | *No description.* | +| followersUrl | java.lang.String | *No description.* | +| followingUrl | java.lang.String | *No description.* | +| gistsUrl | java.lang.String | *No description.* | +| htmlUrl | java.lang.String | *No description.* | +| id | java.lang.Number | *No description.* | +| login | java.lang.String | *No description.* | +| organizationsUrl | java.lang.String | *No description.* | +| permission | java.lang.String | *No description.* | +| receivedEventsUrl | java.lang.String | *No description.* | +| reposUrl | java.lang.String | *No description.* | +| siteAdmin | io.cdktn.cdktn.IResolvable | *No description.* | +| starredUrl | java.lang.String | *No description.* | +| subscriptionsUrl | java.lang.String | *No description.* | +| type | java.lang.String | *No description.* | +| url | java.lang.String | *No description.* | +| internalValue | DataGithubCollaboratorsCollaborator | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `eventsUrl`Required + +```java +public java.lang.String getEventsUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `followersUrl`Required + +```java +public java.lang.String getFollowersUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `followingUrl`Required + +```java +public java.lang.String getFollowingUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `gistsUrl`Required + +```java +public java.lang.String getGistsUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `htmlUrl`Required + +```java +public java.lang.String getHtmlUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.Number getId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `login`Required + +```java +public java.lang.String getLogin(); +``` + +- *Type:* java.lang.String + +--- + +##### `organizationsUrl`Required + +```java +public java.lang.String getOrganizationsUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `permission`Required + +```java +public java.lang.String getPermission(); +``` + +- *Type:* java.lang.String + +--- + +##### `receivedEventsUrl`Required + +```java +public java.lang.String getReceivedEventsUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `reposUrl`Required + +```java +public java.lang.String getReposUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `siteAdmin`Required + +```java +public IResolvable getSiteAdmin(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `starredUrl`Required + +```java +public java.lang.String getStarredUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `subscriptionsUrl`Required + +```java +public java.lang.String getSubscriptionsUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `type`Required + +```java +public java.lang.String getType(); +``` + +- *Type:* java.lang.String + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubCollaboratorsCollaborator getInternalValue(); +``` + +- *Type:* DataGithubCollaboratorsCollaborator + +--- + + + diff --git a/docs/dataGithubDependabotOrganizationPublicKey.csharp.md b/docs/dataGithubDependabotOrganizationPublicKey.csharp.md new file mode 100644 index 000000000..a113d476b --- /dev/null +++ b/docs/dataGithubDependabotOrganizationPublicKey.csharp.md @@ -0,0 +1,734 @@ +# `dataGithubDependabotOrganizationPublicKey` Submodule + +## Constructs + +### DataGithubDependabotOrganizationPublicKey + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_organization_public_key github_dependabot_organization_public_key}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubDependabotOrganizationPublicKey(Construct Scope, string Id, DataGithubDependabotOrganizationPublicKeyConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubDependabotOrganizationPublicKeyConfig | *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`Optional + +- *Type:* DataGithubDependabotOrganizationPublicKeyConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubDependabotOrganizationPublicKey resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubDependabotOrganizationPublicKey.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubDependabotOrganizationPublicKey.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubDependabotOrganizationPublicKey.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubDependabotOrganizationPublicKey.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubDependabotOrganizationPublicKey resource upon running "cdktn 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 DataGithubDependabotOrganizationPublicKey to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubDependabotOrganizationPublicKey that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_organization_public_key#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubDependabotOrganizationPublicKey to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Key | string | *No description.* | +| KeyId | string | *No description.* | +| IdInput | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Key`Required + +```csharp +public string Key { get; } +``` + +- *Type:* string + +--- + +##### `KeyId`Required + +```csharp +public string KeyId { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubDependabotOrganizationPublicKeyConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubDependabotOrganizationPublicKeyConfig { + 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 Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_organization_public_key#id DataGithubDependabotOrganizationPublicKey#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_organization_public_key#id DataGithubDependabotOrganizationPublicKey#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. + +--- + + + diff --git a/docs/dataGithubDependabotOrganizationPublicKey.java.md b/docs/dataGithubDependabotOrganizationPublicKey.java.md new file mode 100644 index 000000000..de939d291 --- /dev/null +++ b/docs/dataGithubDependabotOrganizationPublicKey.java.md @@ -0,0 +1,797 @@ +# `dataGithubDependabotOrganizationPublicKey` Submodule + +## Constructs + +### DataGithubDependabotOrganizationPublicKey + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_organization_public_key github_dependabot_organization_public_key}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_dependabot_organization_public_key.DataGithubDependabotOrganizationPublicKey; + +DataGithubDependabotOrganizationPublicKey.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_organization_public_key#id DataGithubDependabotOrganizationPublicKey#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_organization_public_key#id DataGithubDependabotOrganizationPublicKey#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubDependabotOrganizationPublicKey resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_dependabot_organization_public_key.DataGithubDependabotOrganizationPublicKey; + +DataGithubDependabotOrganizationPublicKey.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` + +```java +import io.cdktn.providers.github.data_github_dependabot_organization_public_key.DataGithubDependabotOrganizationPublicKey; + +DataGithubDependabotOrganizationPublicKey.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_dependabot_organization_public_key.DataGithubDependabotOrganizationPublicKey; + +DataGithubDependabotOrganizationPublicKey.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_dependabot_organization_public_key.DataGithubDependabotOrganizationPublicKey; + +DataGithubDependabotOrganizationPublicKey.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubDependabotOrganizationPublicKey.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubDependabotOrganizationPublicKey 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 DataGithubDependabotOrganizationPublicKey to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubDependabotOrganizationPublicKey that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_organization_public_key#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 DataGithubDependabotOrganizationPublicKey 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| key | java.lang.String | *No description.* | +| keyId | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `key`Required + +```java +public java.lang.String getKey(); +``` + +- *Type:* java.lang.String + +--- + +##### `keyId`Required + +```java +public java.lang.String getKeyId(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubDependabotOrganizationPublicKeyConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_dependabot_organization_public_key.DataGithubDependabotOrganizationPublicKeyConfig; + +DataGithubDependabotOrganizationPublicKeyConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_organization_public_key#id DataGithubDependabotOrganizationPublicKey#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Optional + +```java +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/dependabot_organization_public_key#id DataGithubDependabotOrganizationPublicKey#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. + +--- + + + diff --git a/docs/dataGithubDependabotOrganizationSecrets.csharp.md b/docs/dataGithubDependabotOrganizationSecrets.csharp.md new file mode 100644 index 000000000..c405bcd6a --- /dev/null +++ b/docs/dataGithubDependabotOrganizationSecrets.csharp.md @@ -0,0 +1,1197 @@ +# `dataGithubDependabotOrganizationSecrets` Submodule + +## Constructs + +### DataGithubDependabotOrganizationSecrets + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_organization_secrets github_dependabot_organization_secrets}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubDependabotOrganizationSecrets(Construct Scope, string Id, DataGithubDependabotOrganizationSecretsConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubDependabotOrganizationSecretsConfig | *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`Optional + +- *Type:* DataGithubDependabotOrganizationSecretsConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubDependabotOrganizationSecrets resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubDependabotOrganizationSecrets.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubDependabotOrganizationSecrets.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubDependabotOrganizationSecrets.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubDependabotOrganizationSecrets.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubDependabotOrganizationSecrets resource upon running "cdktn 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 DataGithubDependabotOrganizationSecrets to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubDependabotOrganizationSecrets that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_organization_secrets#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubDependabotOrganizationSecrets to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Secrets | DataGithubDependabotOrganizationSecretsSecretsList | *No description.* | +| IdInput | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Secrets`Required + +```csharp +public DataGithubDependabotOrganizationSecretsSecretsList Secrets { get; } +``` + +- *Type:* DataGithubDependabotOrganizationSecretsSecretsList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubDependabotOrganizationSecretsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubDependabotOrganizationSecretsConfig { + 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 Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_organization_secrets#id DataGithubDependabotOrganizationSecrets#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_organization_secrets#id DataGithubDependabotOrganizationSecrets#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. + +--- + +### DataGithubDependabotOrganizationSecretsSecrets + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubDependabotOrganizationSecretsSecrets { + +}; +``` + + +## Classes + +### DataGithubDependabotOrganizationSecretsSecretsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubDependabotOrganizationSecretsSecretsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubDependabotOrganizationSecretsSecretsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubDependabotOrganizationSecretsSecretsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubDependabotOrganizationSecretsSecretsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| CreatedAt | string | *No description.* | +| Name | string | *No description.* | +| UpdatedAt | string | *No description.* | +| Visibility | string | *No description.* | +| InternalValue | DataGithubDependabotOrganizationSecretsSecrets | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Visibility`Required + +```csharp +public string Visibility { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubDependabotOrganizationSecretsSecrets InternalValue { get; } +``` + +- *Type:* DataGithubDependabotOrganizationSecretsSecrets + +--- + + + diff --git a/docs/dataGithubDependabotOrganizationSecrets.java.md b/docs/dataGithubDependabotOrganizationSecrets.java.md new file mode 100644 index 000000000..09fd8b1c2 --- /dev/null +++ b/docs/dataGithubDependabotOrganizationSecrets.java.md @@ -0,0 +1,1259 @@ +# `dataGithubDependabotOrganizationSecrets` Submodule + +## Constructs + +### DataGithubDependabotOrganizationSecrets + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_organization_secrets github_dependabot_organization_secrets}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_dependabot_organization_secrets.DataGithubDependabotOrganizationSecrets; + +DataGithubDependabotOrganizationSecrets.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_organization_secrets#id DataGithubDependabotOrganizationSecrets#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_organization_secrets#id DataGithubDependabotOrganizationSecrets#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubDependabotOrganizationSecrets resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_dependabot_organization_secrets.DataGithubDependabotOrganizationSecrets; + +DataGithubDependabotOrganizationSecrets.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` + +```java +import io.cdktn.providers.github.data_github_dependabot_organization_secrets.DataGithubDependabotOrganizationSecrets; + +DataGithubDependabotOrganizationSecrets.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_dependabot_organization_secrets.DataGithubDependabotOrganizationSecrets; + +DataGithubDependabotOrganizationSecrets.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_dependabot_organization_secrets.DataGithubDependabotOrganizationSecrets; + +DataGithubDependabotOrganizationSecrets.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubDependabotOrganizationSecrets.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubDependabotOrganizationSecrets 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 DataGithubDependabotOrganizationSecrets to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubDependabotOrganizationSecrets that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_organization_secrets#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 DataGithubDependabotOrganizationSecrets 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| secrets | DataGithubDependabotOrganizationSecretsSecretsList | *No description.* | +| idInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `secrets`Required + +```java +public DataGithubDependabotOrganizationSecretsSecretsList getSecrets(); +``` + +- *Type:* DataGithubDependabotOrganizationSecretsSecretsList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubDependabotOrganizationSecretsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_dependabot_organization_secrets.DataGithubDependabotOrganizationSecretsConfig; + +DataGithubDependabotOrganizationSecretsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_organization_secrets#id DataGithubDependabotOrganizationSecrets#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Optional + +```java +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/dependabot_organization_secrets#id DataGithubDependabotOrganizationSecrets#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. + +--- + +### DataGithubDependabotOrganizationSecretsSecrets + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_dependabot_organization_secrets.DataGithubDependabotOrganizationSecretsSecrets; + +DataGithubDependabotOrganizationSecretsSecrets.builder() + .build(); +``` + + +## Classes + +### DataGithubDependabotOrganizationSecretsSecretsList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_dependabot_organization_secrets.DataGithubDependabotOrganizationSecretsSecretsList; + +new DataGithubDependabotOrganizationSecretsSecretsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubDependabotOrganizationSecretsSecretsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubDependabotOrganizationSecretsSecretsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_dependabot_organization_secrets.DataGithubDependabotOrganizationSecretsSecretsOutputReference; + +new DataGithubDependabotOrganizationSecretsSecretsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| createdAt | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| visibility | java.lang.String | *No description.* | +| internalValue | DataGithubDependabotOrganizationSecretsSecrets | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `visibility`Required + +```java +public java.lang.String getVisibility(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubDependabotOrganizationSecretsSecrets getInternalValue(); +``` + +- *Type:* DataGithubDependabotOrganizationSecretsSecrets + +--- + + + diff --git a/docs/dataGithubDependabotPublicKey.csharp.md b/docs/dataGithubDependabotPublicKey.csharp.md new file mode 100644 index 000000000..2dde708c5 --- /dev/null +++ b/docs/dataGithubDependabotPublicKey.csharp.md @@ -0,0 +1,770 @@ +# `dataGithubDependabotPublicKey` Submodule + +## Constructs + +### DataGithubDependabotPublicKey + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_public_key github_dependabot_public_key}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubDependabotPublicKey(Construct Scope, string Id, DataGithubDependabotPublicKeyConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubDependabotPublicKeyConfig | *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:* DataGithubDependabotPublicKeyConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubDependabotPublicKey resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubDependabotPublicKey.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubDependabotPublicKey.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubDependabotPublicKey.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubDependabotPublicKey.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubDependabotPublicKey resource upon running "cdktn 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 DataGithubDependabotPublicKey to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubDependabotPublicKey that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_public_key#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubDependabotPublicKey to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Key | string | *No description.* | +| KeyId | string | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Key`Required + +```csharp +public string Key { get; } +``` + +- *Type:* string + +--- + +##### `KeyId`Required + +```csharp +public string KeyId { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubDependabotPublicKeyConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubDependabotPublicKeyConfig { + 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 Repository, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_public_key#repository DataGithubDependabotPublicKey#repository}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_public_key#id DataGithubDependabotPublicKey#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_public_key#repository DataGithubDependabotPublicKey#repository}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_public_key#id DataGithubDependabotPublicKey#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. + +--- + + + diff --git a/docs/dataGithubDependabotPublicKey.java.md b/docs/dataGithubDependabotPublicKey.java.md new file mode 100644 index 000000000..b64d6ebb1 --- /dev/null +++ b/docs/dataGithubDependabotPublicKey.java.md @@ -0,0 +1,843 @@ +# `dataGithubDependabotPublicKey` Submodule + +## Constructs + +### DataGithubDependabotPublicKey + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_public_key github_dependabot_public_key}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_dependabot_public_key.DataGithubDependabotPublicKey; + +DataGithubDependabotPublicKey.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_public_key#repository DataGithubDependabotPublicKey#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_public_key#id DataGithubDependabotPublicKey#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_public_key#repository DataGithubDependabotPublicKey#repository}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_public_key#id DataGithubDependabotPublicKey#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubDependabotPublicKey resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_dependabot_public_key.DataGithubDependabotPublicKey; + +DataGithubDependabotPublicKey.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` + +```java +import io.cdktn.providers.github.data_github_dependabot_public_key.DataGithubDependabotPublicKey; + +DataGithubDependabotPublicKey.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_dependabot_public_key.DataGithubDependabotPublicKey; + +DataGithubDependabotPublicKey.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_dependabot_public_key.DataGithubDependabotPublicKey; + +DataGithubDependabotPublicKey.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubDependabotPublicKey.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubDependabotPublicKey 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 DataGithubDependabotPublicKey to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubDependabotPublicKey that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_public_key#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 DataGithubDependabotPublicKey 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| key | java.lang.String | *No description.* | +| keyId | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `key`Required + +```java +public java.lang.String getKey(); +``` + +- *Type:* java.lang.String + +--- + +##### `keyId`Required + +```java +public java.lang.String getKeyId(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubDependabotPublicKeyConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_dependabot_public_key.DataGithubDependabotPublicKeyConfig; + +DataGithubDependabotPublicKeyConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_public_key#repository DataGithubDependabotPublicKey#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_public_key#id DataGithubDependabotPublicKey#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_public_key#repository DataGithubDependabotPublicKey#repository}. + +--- + +##### `id`Optional + +```java +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/dependabot_public_key#id DataGithubDependabotPublicKey#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. + +--- + + + diff --git a/docs/dataGithubDependabotSecrets.csharp.md b/docs/dataGithubDependabotSecrets.csharp.md new file mode 100644 index 000000000..c9392de3b --- /dev/null +++ b/docs/dataGithubDependabotSecrets.csharp.md @@ -0,0 +1,1272 @@ +# `dataGithubDependabotSecrets` Submodule + +## Constructs + +### DataGithubDependabotSecrets + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_secrets github_dependabot_secrets}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubDependabotSecrets(Construct Scope, string Id, DataGithubDependabotSecretsConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubDependabotSecretsConfig | *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`Optional + +- *Type:* DataGithubDependabotSecretsConfig + +--- + +#### 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.* | +| ResetFullName | *No description.* | +| ResetId | *No description.* | +| ResetName | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetFullName` + +```csharp +private void ResetFullName() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetName` + +```csharp +private void ResetName() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubDependabotSecrets resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubDependabotSecrets.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubDependabotSecrets.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubDependabotSecrets.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubDependabotSecrets.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubDependabotSecrets resource upon running "cdktn 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 DataGithubDependabotSecrets to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubDependabotSecrets that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_secrets#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubDependabotSecrets to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Secrets | DataGithubDependabotSecretsSecretsList | *No description.* | +| FullNameInput | string | *No description.* | +| IdInput | string | *No description.* | +| NameInput | string | *No description.* | +| FullName | string | *No description.* | +| Id | string | *No description.* | +| Name | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Secrets`Required + +```csharp +public DataGithubDependabotSecretsSecretsList Secrets { get; } +``` + +- *Type:* DataGithubDependabotSecretsSecretsList + +--- + +##### `FullNameInput`Optional + +```csharp +public string FullNameInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `FullName`Required + +```csharp +public string FullName { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubDependabotSecretsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubDependabotSecretsConfig { + 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 FullName = null, + string Id = null, + string Name = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| FullName | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_secrets#full_name DataGithubDependabotSecrets#full_name}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_secrets#id DataGithubDependabotSecrets#id}. | +| Name | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_secrets#name DataGithubDependabotSecrets#name}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `FullName`Optional + +```csharp +public string FullName { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_secrets#full_name DataGithubDependabotSecrets#full_name}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_secrets#id DataGithubDependabotSecrets#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. + +--- + +##### `Name`Optional + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_secrets#name DataGithubDependabotSecrets#name}. + +--- + +### DataGithubDependabotSecretsSecrets + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubDependabotSecretsSecrets { + +}; +``` + + +## Classes + +### DataGithubDependabotSecretsSecretsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubDependabotSecretsSecretsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubDependabotSecretsSecretsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubDependabotSecretsSecretsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubDependabotSecretsSecretsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| CreatedAt | string | *No description.* | +| Name | string | *No description.* | +| UpdatedAt | string | *No description.* | +| InternalValue | DataGithubDependabotSecretsSecrets | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubDependabotSecretsSecrets InternalValue { get; } +``` + +- *Type:* DataGithubDependabotSecretsSecrets + +--- + + + diff --git a/docs/dataGithubDependabotSecrets.java.md b/docs/dataGithubDependabotSecrets.java.md new file mode 100644 index 000000000..ab9295f2b --- /dev/null +++ b/docs/dataGithubDependabotSecrets.java.md @@ -0,0 +1,1354 @@ +# `dataGithubDependabotSecrets` Submodule + +## Constructs + +### DataGithubDependabotSecrets + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_secrets github_dependabot_secrets}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_dependabot_secrets.DataGithubDependabotSecrets; + +DataGithubDependabotSecrets.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .fullName(java.lang.String) +// .id(java.lang.String) +// .name(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 | *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 | *No description.* | +| fullName | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_secrets#full_name DataGithubDependabotSecrets#full_name}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_secrets#id DataGithubDependabotSecrets#id}. | +| name | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_secrets#name DataGithubDependabotSecrets#name}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `fullName`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_secrets#full_name DataGithubDependabotSecrets#full_name}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_secrets#id DataGithubDependabotSecrets#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. + +--- + +##### `name`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_secrets#name DataGithubDependabotSecrets#name}. + +--- + +#### 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.* | +| resetFullName | *No description.* | +| resetId | *No description.* | +| resetName | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetFullName` + +```java +public void resetFullName() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetName` + +```java +public void resetName() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubDependabotSecrets resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_dependabot_secrets.DataGithubDependabotSecrets; + +DataGithubDependabotSecrets.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` + +```java +import io.cdktn.providers.github.data_github_dependabot_secrets.DataGithubDependabotSecrets; + +DataGithubDependabotSecrets.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_dependabot_secrets.DataGithubDependabotSecrets; + +DataGithubDependabotSecrets.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_dependabot_secrets.DataGithubDependabotSecrets; + +DataGithubDependabotSecrets.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubDependabotSecrets.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubDependabotSecrets 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 DataGithubDependabotSecrets to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubDependabotSecrets that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_secrets#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 DataGithubDependabotSecrets 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| secrets | DataGithubDependabotSecretsSecretsList | *No description.* | +| fullNameInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| fullName | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `secrets`Required + +```java +public DataGithubDependabotSecretsSecretsList getSecrets(); +``` + +- *Type:* DataGithubDependabotSecretsSecretsList + +--- + +##### `fullNameInput`Optional + +```java +public java.lang.String getFullNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `fullName`Required + +```java +public java.lang.String getFullName(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubDependabotSecretsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_dependabot_secrets.DataGithubDependabotSecretsConfig; + +DataGithubDependabotSecretsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .fullName(java.lang.String) +// .id(java.lang.String) +// .name(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 | *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 | *No description.* | +| fullName | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_secrets#full_name DataGithubDependabotSecrets#full_name}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_secrets#id DataGithubDependabotSecrets#id}. | +| name | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_secrets#name DataGithubDependabotSecrets#name}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `fullName`Optional + +```java +public java.lang.String getFullName(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/dependabot_secrets#full_name DataGithubDependabotSecrets#full_name}. + +--- + +##### `id`Optional + +```java +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/dependabot_secrets#id DataGithubDependabotSecrets#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. + +--- + +##### `name`Optional + +```java +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/dependabot_secrets#name DataGithubDependabotSecrets#name}. + +--- + +### DataGithubDependabotSecretsSecrets + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_dependabot_secrets.DataGithubDependabotSecretsSecrets; + +DataGithubDependabotSecretsSecrets.builder() + .build(); +``` + + +## Classes + +### DataGithubDependabotSecretsSecretsList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_dependabot_secrets.DataGithubDependabotSecretsSecretsList; + +new DataGithubDependabotSecretsSecretsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubDependabotSecretsSecretsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubDependabotSecretsSecretsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_dependabot_secrets.DataGithubDependabotSecretsSecretsOutputReference; + +new DataGithubDependabotSecretsSecretsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| createdAt | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| internalValue | DataGithubDependabotSecretsSecrets | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubDependabotSecretsSecrets getInternalValue(); +``` + +- *Type:* DataGithubDependabotSecretsSecrets + +--- + + + diff --git a/docs/dataGithubEnterprise.csharp.md b/docs/dataGithubEnterprise.csharp.md new file mode 100644 index 000000000..68c17fb70 --- /dev/null +++ b/docs/dataGithubEnterprise.csharp.md @@ -0,0 +1,803 @@ +# `dataGithubEnterprise` Submodule + +## Constructs + +### DataGithubEnterprise + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/enterprise github_enterprise}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubEnterprise(Construct Scope, string Id, DataGithubEnterpriseConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubEnterpriseConfig | *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:* DataGithubEnterpriseConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubEnterprise resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubEnterprise.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubEnterprise.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubEnterprise.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubEnterprise.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubEnterprise resource upon running "cdktn 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 DataGithubEnterprise to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubEnterprise that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/enterprise#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubEnterprise to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| CreatedAt | string | *No description.* | +| DatabaseId | double | *No description.* | +| Description | string | *No description.* | +| Name | string | *No description.* | +| Url | string | *No description.* | +| IdInput | string | *No description.* | +| SlugInput | string | *No description.* | +| Id | string | *No description.* | +| Slug | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `DatabaseId`Required + +```csharp +public double DatabaseId { get; } +``` + +- *Type:* double + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Url`Required + +```csharp +public string Url { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `SlugInput`Optional + +```csharp +public string SlugInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Slug`Required + +```csharp +public string Slug { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubEnterpriseConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubEnterpriseConfig { + 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 Slug, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Slug | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/enterprise#slug DataGithubEnterprise#slug}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/enterprise#id DataGithubEnterprise#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Slug`Required + +```csharp +public string Slug { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/enterprise#slug DataGithubEnterprise#slug}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/enterprise#id DataGithubEnterprise#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. + +--- + + + diff --git a/docs/dataGithubEnterprise.java.md b/docs/dataGithubEnterprise.java.md new file mode 100644 index 000000000..704a45f7b --- /dev/null +++ b/docs/dataGithubEnterprise.java.md @@ -0,0 +1,876 @@ +# `dataGithubEnterprise` Submodule + +## Constructs + +### DataGithubEnterprise + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/enterprise github_enterprise}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_enterprise.DataGithubEnterprise; + +DataGithubEnterprise.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .slug(java.lang.String) +// .id(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 | *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 | *No description.* | +| slug | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/enterprise#slug DataGithubEnterprise#slug}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/enterprise#id DataGithubEnterprise#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `slug`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/enterprise#slug DataGithubEnterprise#slug}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/enterprise#id DataGithubEnterprise#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubEnterprise resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_enterprise.DataGithubEnterprise; + +DataGithubEnterprise.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` + +```java +import io.cdktn.providers.github.data_github_enterprise.DataGithubEnterprise; + +DataGithubEnterprise.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_enterprise.DataGithubEnterprise; + +DataGithubEnterprise.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_enterprise.DataGithubEnterprise; + +DataGithubEnterprise.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubEnterprise.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubEnterprise 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 DataGithubEnterprise to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubEnterprise that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/enterprise#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 DataGithubEnterprise 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| createdAt | java.lang.String | *No description.* | +| databaseId | java.lang.Number | *No description.* | +| description | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| url | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| slugInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| slug | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `databaseId`Required + +```java +public java.lang.Number getDatabaseId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `slugInput`Optional + +```java +public java.lang.String getSlugInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `slug`Required + +```java +public java.lang.String getSlug(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubEnterpriseConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_enterprise.DataGithubEnterpriseConfig; + +DataGithubEnterpriseConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .slug(java.lang.String) +// .id(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 | *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 | *No description.* | +| slug | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/enterprise#slug DataGithubEnterprise#slug}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/enterprise#id DataGithubEnterprise#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `slug`Required + +```java +public java.lang.String getSlug(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/enterprise#slug DataGithubEnterprise#slug}. + +--- + +##### `id`Optional + +```java +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/enterprise#id DataGithubEnterprise#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. + +--- + + + diff --git a/docs/dataGithubExternalGroups.csharp.md b/docs/dataGithubExternalGroups.csharp.md new file mode 100644 index 000000000..1497ac74d --- /dev/null +++ b/docs/dataGithubExternalGroups.csharp.md @@ -0,0 +1,1186 @@ +# `dataGithubExternalGroups` Submodule + +## Constructs + +### DataGithubExternalGroups + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/external_groups github_external_groups}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubExternalGroups(Construct Scope, string Id, DataGithubExternalGroupsConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubExternalGroupsConfig | *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`Optional + +- *Type:* DataGithubExternalGroupsConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubExternalGroups resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubExternalGroups.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubExternalGroups.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubExternalGroups.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubExternalGroups.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubExternalGroups resource upon running "cdktn 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 DataGithubExternalGroups to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubExternalGroups that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/external_groups#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubExternalGroups to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| ExternalGroups | DataGithubExternalGroupsExternalGroupsList | *No description.* | +| IdInput | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `ExternalGroups`Required + +```csharp +public DataGithubExternalGroupsExternalGroupsList ExternalGroups { get; } +``` + +- *Type:* DataGithubExternalGroupsExternalGroupsList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubExternalGroupsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubExternalGroupsConfig { + 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 Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/external_groups#id DataGithubExternalGroups#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/external_groups#id DataGithubExternalGroups#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. + +--- + +### DataGithubExternalGroupsExternalGroups + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubExternalGroupsExternalGroups { + +}; +``` + + +## Classes + +### DataGithubExternalGroupsExternalGroupsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubExternalGroupsExternalGroupsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubExternalGroupsExternalGroupsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubExternalGroupsExternalGroupsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubExternalGroupsExternalGroupsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| GroupId | double | *No description.* | +| GroupName | string | *No description.* | +| UpdatedAt | string | *No description.* | +| InternalValue | DataGithubExternalGroupsExternalGroups | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `GroupId`Required + +```csharp +public double GroupId { get; } +``` + +- *Type:* double + +--- + +##### `GroupName`Required + +```csharp +public string GroupName { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubExternalGroupsExternalGroups InternalValue { get; } +``` + +- *Type:* DataGithubExternalGroupsExternalGroups + +--- + + + diff --git a/docs/dataGithubExternalGroups.java.md b/docs/dataGithubExternalGroups.java.md new file mode 100644 index 000000000..3239f207e --- /dev/null +++ b/docs/dataGithubExternalGroups.java.md @@ -0,0 +1,1248 @@ +# `dataGithubExternalGroups` Submodule + +## Constructs + +### DataGithubExternalGroups + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/external_groups github_external_groups}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_external_groups.DataGithubExternalGroups; + +DataGithubExternalGroups.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/external_groups#id DataGithubExternalGroups#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/external_groups#id DataGithubExternalGroups#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubExternalGroups resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_external_groups.DataGithubExternalGroups; + +DataGithubExternalGroups.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` + +```java +import io.cdktn.providers.github.data_github_external_groups.DataGithubExternalGroups; + +DataGithubExternalGroups.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_external_groups.DataGithubExternalGroups; + +DataGithubExternalGroups.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_external_groups.DataGithubExternalGroups; + +DataGithubExternalGroups.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubExternalGroups.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubExternalGroups 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 DataGithubExternalGroups to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubExternalGroups that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/external_groups#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 DataGithubExternalGroups 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| externalGroups | DataGithubExternalGroupsExternalGroupsList | *No description.* | +| idInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `externalGroups`Required + +```java +public DataGithubExternalGroupsExternalGroupsList getExternalGroups(); +``` + +- *Type:* DataGithubExternalGroupsExternalGroupsList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubExternalGroupsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_external_groups.DataGithubExternalGroupsConfig; + +DataGithubExternalGroupsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/external_groups#id DataGithubExternalGroups#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Optional + +```java +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/external_groups#id DataGithubExternalGroups#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. + +--- + +### DataGithubExternalGroupsExternalGroups + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_external_groups.DataGithubExternalGroupsExternalGroups; + +DataGithubExternalGroupsExternalGroups.builder() + .build(); +``` + + +## Classes + +### DataGithubExternalGroupsExternalGroupsList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_external_groups.DataGithubExternalGroupsExternalGroupsList; + +new DataGithubExternalGroupsExternalGroupsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubExternalGroupsExternalGroupsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubExternalGroupsExternalGroupsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_external_groups.DataGithubExternalGroupsExternalGroupsOutputReference; + +new DataGithubExternalGroupsExternalGroupsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| groupId | java.lang.Number | *No description.* | +| groupName | java.lang.String | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| internalValue | DataGithubExternalGroupsExternalGroups | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `groupId`Required + +```java +public java.lang.Number getGroupId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `groupName`Required + +```java +public java.lang.String getGroupName(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubExternalGroupsExternalGroups getInternalValue(); +``` + +- *Type:* DataGithubExternalGroupsExternalGroups + +--- + + + diff --git a/docs/dataGithubIpRanges.csharp.md b/docs/dataGithubIpRanges.csharp.md new file mode 100644 index 000000000..9df7f7150 --- /dev/null +++ b/docs/dataGithubIpRanges.csharp.md @@ -0,0 +1,1075 @@ +# `dataGithubIpRanges` Submodule + +## Constructs + +### DataGithubIpRanges + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ip_ranges github_ip_ranges}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubIpRanges(Construct Scope, string Id, DataGithubIpRangesConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubIpRangesConfig | *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`Optional + +- *Type:* DataGithubIpRangesConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubIpRanges resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubIpRanges.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubIpRanges.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubIpRanges.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubIpRanges.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubIpRanges resource upon running "cdktn 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 DataGithubIpRanges to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubIpRanges that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ip_ranges#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubIpRanges to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Actions | string[] | *No description.* | +| ActionsIpv4 | string[] | *No description.* | +| ActionsIpv6 | string[] | *No description.* | +| ActionsMacos | string[] | *No description.* | +| ActionsMacosIpv4 | string[] | *No description.* | +| ActionsMacosIpv6 | string[] | *No description.* | +| Api | string[] | *No description.* | +| ApiIpv4 | string[] | *No description.* | +| ApiIpv6 | string[] | *No description.* | +| Dependabot | string[] | *No description.* | +| DependabotIpv4 | string[] | *No description.* | +| DependabotIpv6 | string[] | *No description.* | +| Git | string[] | *No description.* | +| GithubEnterpriseImporter | string[] | *No description.* | +| GithubEnterpriseImporterIpv4 | string[] | *No description.* | +| GithubEnterpriseImporterIpv6 | string[] | *No description.* | +| GitIpv4 | string[] | *No description.* | +| GitIpv6 | string[] | *No description.* | +| Hooks | string[] | *No description.* | +| HooksIpv4 | string[] | *No description.* | +| HooksIpv6 | string[] | *No description.* | +| Importer | string[] | *No description.* | +| ImporterIpv4 | string[] | *No description.* | +| ImporterIpv6 | string[] | *No description.* | +| Packages | string[] | *No description.* | +| PackagesIpv4 | string[] | *No description.* | +| PackagesIpv6 | string[] | *No description.* | +| Pages | string[] | *No description.* | +| PagesIpv4 | string[] | *No description.* | +| PagesIpv6 | string[] | *No description.* | +| Web | string[] | *No description.* | +| WebIpv4 | string[] | *No description.* | +| WebIpv6 | string[] | *No description.* | +| IdInput | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Actions`Required + +```csharp +public string[] Actions { get; } +``` + +- *Type:* string[] + +--- + +##### `ActionsIpv4`Required + +```csharp +public string[] ActionsIpv4 { get; } +``` + +- *Type:* string[] + +--- + +##### `ActionsIpv6`Required + +```csharp +public string[] ActionsIpv6 { get; } +``` + +- *Type:* string[] + +--- + +##### `ActionsMacos`Required + +```csharp +public string[] ActionsMacos { get; } +``` + +- *Type:* string[] + +--- + +##### `ActionsMacosIpv4`Required + +```csharp +public string[] ActionsMacosIpv4 { get; } +``` + +- *Type:* string[] + +--- + +##### `ActionsMacosIpv6`Required + +```csharp +public string[] ActionsMacosIpv6 { get; } +``` + +- *Type:* string[] + +--- + +##### `Api`Required + +```csharp +public string[] Api { get; } +``` + +- *Type:* string[] + +--- + +##### `ApiIpv4`Required + +```csharp +public string[] ApiIpv4 { get; } +``` + +- *Type:* string[] + +--- + +##### `ApiIpv6`Required + +```csharp +public string[] ApiIpv6 { get; } +``` + +- *Type:* string[] + +--- + +##### `Dependabot`Required + +```csharp +public string[] Dependabot { get; } +``` + +- *Type:* string[] + +--- + +##### `DependabotIpv4`Required + +```csharp +public string[] DependabotIpv4 { get; } +``` + +- *Type:* string[] + +--- + +##### `DependabotIpv6`Required + +```csharp +public string[] DependabotIpv6 { get; } +``` + +- *Type:* string[] + +--- + +##### `Git`Required + +```csharp +public string[] Git { get; } +``` + +- *Type:* string[] + +--- + +##### `GithubEnterpriseImporter`Required + +```csharp +public string[] GithubEnterpriseImporter { get; } +``` + +- *Type:* string[] + +--- + +##### `GithubEnterpriseImporterIpv4`Required + +```csharp +public string[] GithubEnterpriseImporterIpv4 { get; } +``` + +- *Type:* string[] + +--- + +##### `GithubEnterpriseImporterIpv6`Required + +```csharp +public string[] GithubEnterpriseImporterIpv6 { get; } +``` + +- *Type:* string[] + +--- + +##### `GitIpv4`Required + +```csharp +public string[] GitIpv4 { get; } +``` + +- *Type:* string[] + +--- + +##### `GitIpv6`Required + +```csharp +public string[] GitIpv6 { get; } +``` + +- *Type:* string[] + +--- + +##### `Hooks`Required + +```csharp +public string[] Hooks { get; } +``` + +- *Type:* string[] + +--- + +##### `HooksIpv4`Required + +```csharp +public string[] HooksIpv4 { get; } +``` + +- *Type:* string[] + +--- + +##### `HooksIpv6`Required + +```csharp +public string[] HooksIpv6 { get; } +``` + +- *Type:* string[] + +--- + +##### `Importer`Required + +```csharp +public string[] Importer { get; } +``` + +- *Type:* string[] + +--- + +##### `ImporterIpv4`Required + +```csharp +public string[] ImporterIpv4 { get; } +``` + +- *Type:* string[] + +--- + +##### `ImporterIpv6`Required + +```csharp +public string[] ImporterIpv6 { get; } +``` + +- *Type:* string[] + +--- + +##### `Packages`Required + +```csharp +public string[] Packages { get; } +``` + +- *Type:* string[] + +--- + +##### `PackagesIpv4`Required + +```csharp +public string[] PackagesIpv4 { get; } +``` + +- *Type:* string[] + +--- + +##### `PackagesIpv6`Required + +```csharp +public string[] PackagesIpv6 { get; } +``` + +- *Type:* string[] + +--- + +##### `Pages`Required + +```csharp +public string[] Pages { get; } +``` + +- *Type:* string[] + +--- + +##### `PagesIpv4`Required + +```csharp +public string[] PagesIpv4 { get; } +``` + +- *Type:* string[] + +--- + +##### `PagesIpv6`Required + +```csharp +public string[] PagesIpv6 { get; } +``` + +- *Type:* string[] + +--- + +##### `Web`Required + +```csharp +public string[] Web { get; } +``` + +- *Type:* string[] + +--- + +##### `WebIpv4`Required + +```csharp +public string[] WebIpv4 { get; } +``` + +- *Type:* string[] + +--- + +##### `WebIpv6`Required + +```csharp +public string[] WebIpv6 { get; } +``` + +- *Type:* string[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubIpRangesConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubIpRangesConfig { + 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 Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ip_ranges#id DataGithubIpRanges#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ip_ranges#id DataGithubIpRanges#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. + +--- + + + diff --git a/docs/dataGithubIpRanges.java.md b/docs/dataGithubIpRanges.java.md new file mode 100644 index 000000000..2c153ac0e --- /dev/null +++ b/docs/dataGithubIpRanges.java.md @@ -0,0 +1,1138 @@ +# `dataGithubIpRanges` Submodule + +## Constructs + +### DataGithubIpRanges + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ip_ranges github_ip_ranges}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_ip_ranges.DataGithubIpRanges; + +DataGithubIpRanges.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ip_ranges#id DataGithubIpRanges#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ip_ranges#id DataGithubIpRanges#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubIpRanges resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_ip_ranges.DataGithubIpRanges; + +DataGithubIpRanges.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` + +```java +import io.cdktn.providers.github.data_github_ip_ranges.DataGithubIpRanges; + +DataGithubIpRanges.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_ip_ranges.DataGithubIpRanges; + +DataGithubIpRanges.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_ip_ranges.DataGithubIpRanges; + +DataGithubIpRanges.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubIpRanges.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubIpRanges 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 DataGithubIpRanges to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubIpRanges that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ip_ranges#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 DataGithubIpRanges 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| actions | java.util.List | *No description.* | +| actionsIpv4 | java.util.List | *No description.* | +| actionsIpv6 | java.util.List | *No description.* | +| actionsMacos | java.util.List | *No description.* | +| actionsMacosIpv4 | java.util.List | *No description.* | +| actionsMacosIpv6 | java.util.List | *No description.* | +| api | java.util.List | *No description.* | +| apiIpv4 | java.util.List | *No description.* | +| apiIpv6 | java.util.List | *No description.* | +| dependabot | java.util.List | *No description.* | +| dependabotIpv4 | java.util.List | *No description.* | +| dependabotIpv6 | java.util.List | *No description.* | +| git | java.util.List | *No description.* | +| githubEnterpriseImporter | java.util.List | *No description.* | +| githubEnterpriseImporterIpv4 | java.util.List | *No description.* | +| githubEnterpriseImporterIpv6 | java.util.List | *No description.* | +| gitIpv4 | java.util.List | *No description.* | +| gitIpv6 | java.util.List | *No description.* | +| hooks | java.util.List | *No description.* | +| hooksIpv4 | java.util.List | *No description.* | +| hooksIpv6 | java.util.List | *No description.* | +| importer | java.util.List | *No description.* | +| importerIpv4 | java.util.List | *No description.* | +| importerIpv6 | java.util.List | *No description.* | +| packages | java.util.List | *No description.* | +| packagesIpv4 | java.util.List | *No description.* | +| packagesIpv6 | java.util.List | *No description.* | +| pages | java.util.List | *No description.* | +| pagesIpv4 | java.util.List | *No description.* | +| pagesIpv6 | java.util.List | *No description.* | +| web | java.util.List | *No description.* | +| webIpv4 | java.util.List | *No description.* | +| webIpv6 | java.util.List | *No description.* | +| idInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `actions`Required + +```java +public java.util.List getActions(); +``` + +- *Type:* java.util.List + +--- + +##### `actionsIpv4`Required + +```java +public java.util.List getActionsIpv4(); +``` + +- *Type:* java.util.List + +--- + +##### `actionsIpv6`Required + +```java +public java.util.List getActionsIpv6(); +``` + +- *Type:* java.util.List + +--- + +##### `actionsMacos`Required + +```java +public java.util.List getActionsMacos(); +``` + +- *Type:* java.util.List + +--- + +##### `actionsMacosIpv4`Required + +```java +public java.util.List getActionsMacosIpv4(); +``` + +- *Type:* java.util.List + +--- + +##### `actionsMacosIpv6`Required + +```java +public java.util.List getActionsMacosIpv6(); +``` + +- *Type:* java.util.List + +--- + +##### `api`Required + +```java +public java.util.List getApi(); +``` + +- *Type:* java.util.List + +--- + +##### `apiIpv4`Required + +```java +public java.util.List getApiIpv4(); +``` + +- *Type:* java.util.List + +--- + +##### `apiIpv6`Required + +```java +public java.util.List getApiIpv6(); +``` + +- *Type:* java.util.List + +--- + +##### `dependabot`Required + +```java +public java.util.List getDependabot(); +``` + +- *Type:* java.util.List + +--- + +##### `dependabotIpv4`Required + +```java +public java.util.List getDependabotIpv4(); +``` + +- *Type:* java.util.List + +--- + +##### `dependabotIpv6`Required + +```java +public java.util.List getDependabotIpv6(); +``` + +- *Type:* java.util.List + +--- + +##### `git`Required + +```java +public java.util.List getGit(); +``` + +- *Type:* java.util.List + +--- + +##### `githubEnterpriseImporter`Required + +```java +public java.util.List getGithubEnterpriseImporter(); +``` + +- *Type:* java.util.List + +--- + +##### `githubEnterpriseImporterIpv4`Required + +```java +public java.util.List getGithubEnterpriseImporterIpv4(); +``` + +- *Type:* java.util.List + +--- + +##### `githubEnterpriseImporterIpv6`Required + +```java +public java.util.List getGithubEnterpriseImporterIpv6(); +``` + +- *Type:* java.util.List + +--- + +##### `gitIpv4`Required + +```java +public java.util.List getGitIpv4(); +``` + +- *Type:* java.util.List + +--- + +##### `gitIpv6`Required + +```java +public java.util.List getGitIpv6(); +``` + +- *Type:* java.util.List + +--- + +##### `hooks`Required + +```java +public java.util.List getHooks(); +``` + +- *Type:* java.util.List + +--- + +##### `hooksIpv4`Required + +```java +public java.util.List getHooksIpv4(); +``` + +- *Type:* java.util.List + +--- + +##### `hooksIpv6`Required + +```java +public java.util.List getHooksIpv6(); +``` + +- *Type:* java.util.List + +--- + +##### `importer`Required + +```java +public java.util.List getImporter(); +``` + +- *Type:* java.util.List + +--- + +##### `importerIpv4`Required + +```java +public java.util.List getImporterIpv4(); +``` + +- *Type:* java.util.List + +--- + +##### `importerIpv6`Required + +```java +public java.util.List getImporterIpv6(); +``` + +- *Type:* java.util.List + +--- + +##### `packages`Required + +```java +public java.util.List getPackages(); +``` + +- *Type:* java.util.List + +--- + +##### `packagesIpv4`Required + +```java +public java.util.List getPackagesIpv4(); +``` + +- *Type:* java.util.List + +--- + +##### `packagesIpv6`Required + +```java +public java.util.List getPackagesIpv6(); +``` + +- *Type:* java.util.List + +--- + +##### `pages`Required + +```java +public java.util.List getPages(); +``` + +- *Type:* java.util.List + +--- + +##### `pagesIpv4`Required + +```java +public java.util.List getPagesIpv4(); +``` + +- *Type:* java.util.List + +--- + +##### `pagesIpv6`Required + +```java +public java.util.List getPagesIpv6(); +``` + +- *Type:* java.util.List + +--- + +##### `web`Required + +```java +public java.util.List getWeb(); +``` + +- *Type:* java.util.List + +--- + +##### `webIpv4`Required + +```java +public java.util.List getWebIpv4(); +``` + +- *Type:* java.util.List + +--- + +##### `webIpv6`Required + +```java +public java.util.List getWebIpv6(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubIpRangesConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_ip_ranges.DataGithubIpRangesConfig; + +DataGithubIpRangesConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ip_ranges#id DataGithubIpRanges#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Optional + +```java +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/ip_ranges#id DataGithubIpRanges#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. + +--- + + + diff --git a/docs/dataGithubIssueLabels.csharp.md b/docs/dataGithubIssueLabels.csharp.md new file mode 100644 index 000000000..db0de86a4 --- /dev/null +++ b/docs/dataGithubIssueLabels.csharp.md @@ -0,0 +1,1233 @@ +# `dataGithubIssueLabels` Submodule + +## Constructs + +### DataGithubIssueLabels + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/issue_labels github_issue_labels}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubIssueLabels(Construct Scope, string Id, DataGithubIssueLabelsConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubIssueLabelsConfig | *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:* DataGithubIssueLabelsConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubIssueLabels resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubIssueLabels.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubIssueLabels.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubIssueLabels.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubIssueLabels.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubIssueLabels resource upon running "cdktn 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 DataGithubIssueLabels to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubIssueLabels that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/issue_labels#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubIssueLabels to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Labels | DataGithubIssueLabelsLabelsList | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Labels`Required + +```csharp +public DataGithubIssueLabelsLabelsList Labels { get; } +``` + +- *Type:* DataGithubIssueLabelsLabelsList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubIssueLabelsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubIssueLabelsConfig { + 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 Repository, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/issue_labels#repository DataGithubIssueLabels#repository}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/issue_labels#id DataGithubIssueLabels#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/issue_labels#repository DataGithubIssueLabels#repository}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/issue_labels#id DataGithubIssueLabels#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. + +--- + +### DataGithubIssueLabelsLabels + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubIssueLabelsLabels { + +}; +``` + + +## Classes + +### DataGithubIssueLabelsLabelsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubIssueLabelsLabelsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubIssueLabelsLabelsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubIssueLabelsLabelsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubIssueLabelsLabelsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Color | string | *No description.* | +| Description | string | *No description.* | +| Name | string | *No description.* | +| Url | string | *No description.* | +| InternalValue | DataGithubIssueLabelsLabels | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Color`Required + +```csharp +public string Color { get; } +``` + +- *Type:* string + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Url`Required + +```csharp +public string Url { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubIssueLabelsLabels InternalValue { get; } +``` + +- *Type:* DataGithubIssueLabelsLabels + +--- + + + diff --git a/docs/dataGithubIssueLabels.java.md b/docs/dataGithubIssueLabels.java.md new file mode 100644 index 000000000..1174b2cba --- /dev/null +++ b/docs/dataGithubIssueLabels.java.md @@ -0,0 +1,1305 @@ +# `dataGithubIssueLabels` Submodule + +## Constructs + +### DataGithubIssueLabels + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/issue_labels github_issue_labels}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_issue_labels.DataGithubIssueLabels; + +DataGithubIssueLabels.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/issue_labels#repository DataGithubIssueLabels#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/issue_labels#id DataGithubIssueLabels#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/issue_labels#repository DataGithubIssueLabels#repository}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/issue_labels#id DataGithubIssueLabels#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubIssueLabels resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_issue_labels.DataGithubIssueLabels; + +DataGithubIssueLabels.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` + +```java +import io.cdktn.providers.github.data_github_issue_labels.DataGithubIssueLabels; + +DataGithubIssueLabels.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_issue_labels.DataGithubIssueLabels; + +DataGithubIssueLabels.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_issue_labels.DataGithubIssueLabels; + +DataGithubIssueLabels.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubIssueLabels.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubIssueLabels 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 DataGithubIssueLabels to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubIssueLabels that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/issue_labels#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 DataGithubIssueLabels 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| labels | DataGithubIssueLabelsLabelsList | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `labels`Required + +```java +public DataGithubIssueLabelsLabelsList getLabels(); +``` + +- *Type:* DataGithubIssueLabelsLabelsList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubIssueLabelsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_issue_labels.DataGithubIssueLabelsConfig; + +DataGithubIssueLabelsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/issue_labels#repository DataGithubIssueLabels#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/issue_labels#id DataGithubIssueLabels#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/issue_labels#repository DataGithubIssueLabels#repository}. + +--- + +##### `id`Optional + +```java +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/issue_labels#id DataGithubIssueLabels#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. + +--- + +### DataGithubIssueLabelsLabels + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_issue_labels.DataGithubIssueLabelsLabels; + +DataGithubIssueLabelsLabels.builder() + .build(); +``` + + +## Classes + +### DataGithubIssueLabelsLabelsList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_issue_labels.DataGithubIssueLabelsLabelsList; + +new DataGithubIssueLabelsLabelsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubIssueLabelsLabelsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubIssueLabelsLabelsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_issue_labels.DataGithubIssueLabelsLabelsOutputReference; + +new DataGithubIssueLabelsLabelsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| color | java.lang.String | *No description.* | +| description | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| url | java.lang.String | *No description.* | +| internalValue | DataGithubIssueLabelsLabels | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `color`Required + +```java +public java.lang.String getColor(); +``` + +- *Type:* java.lang.String + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubIssueLabelsLabels getInternalValue(); +``` + +- *Type:* DataGithubIssueLabelsLabels + +--- + + + diff --git a/docs/dataGithubMembership.csharp.md b/docs/dataGithubMembership.csharp.md new file mode 100644 index 000000000..cc88a5439 --- /dev/null +++ b/docs/dataGithubMembership.csharp.md @@ -0,0 +1,824 @@ +# `dataGithubMembership` Submodule + +## Constructs + +### DataGithubMembership + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/membership github_membership}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubMembership(Construct Scope, string Id, DataGithubMembershipConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubMembershipConfig | *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:* DataGithubMembershipConfig + +--- + +#### 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.* | +| ResetOrganization | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetOrganization` + +```csharp +private void ResetOrganization() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubMembership resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubMembership.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubMembership.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubMembership.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubMembership.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubMembership resource upon running "cdktn 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 DataGithubMembership to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubMembership that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/membership#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubMembership to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Etag | string | *No description.* | +| Role | string | *No description.* | +| State | string | *No description.* | +| IdInput | string | *No description.* | +| OrganizationInput | string | *No description.* | +| UsernameInput | string | *No description.* | +| Id | string | *No description.* | +| Organization | string | *No description.* | +| Username | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `Role`Required + +```csharp +public string Role { get; } +``` + +- *Type:* string + +--- + +##### `State`Required + +```csharp +public string State { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `OrganizationInput`Optional + +```csharp +public string OrganizationInput { get; } +``` + +- *Type:* string + +--- + +##### `UsernameInput`Optional + +```csharp +public string UsernameInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Organization`Required + +```csharp +public string Organization { get; } +``` + +- *Type:* string + +--- + +##### `Username`Required + +```csharp +public string Username { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubMembershipConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubMembershipConfig { + 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 Username, + string Id = null, + string Organization = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Username | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/membership#username DataGithubMembership#username}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/membership#id DataGithubMembership#id}. | +| Organization | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/membership#organization DataGithubMembership#organization}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Username`Required + +```csharp +public string Username { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/membership#username DataGithubMembership#username}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/membership#id DataGithubMembership#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. + +--- + +##### `Organization`Optional + +```csharp +public string Organization { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/membership#organization DataGithubMembership#organization}. + +--- + + + diff --git a/docs/dataGithubMembership.java.md b/docs/dataGithubMembership.java.md new file mode 100644 index 000000000..94e245ff4 --- /dev/null +++ b/docs/dataGithubMembership.java.md @@ -0,0 +1,907 @@ +# `dataGithubMembership` Submodule + +## Constructs + +### DataGithubMembership + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/membership github_membership}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_membership.DataGithubMembership; + +DataGithubMembership.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .username(java.lang.String) +// .id(java.lang.String) +// .organization(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 | *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 | *No description.* | +| username | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/membership#username DataGithubMembership#username}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/membership#id DataGithubMembership#id}. | +| organization | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/membership#organization DataGithubMembership#organization}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `username`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/membership#username DataGithubMembership#username}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/membership#id DataGithubMembership#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. + +--- + +##### `organization`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/membership#organization DataGithubMembership#organization}. + +--- + +#### 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.* | +| resetOrganization | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetOrganization` + +```java +public void resetOrganization() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubMembership resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_membership.DataGithubMembership; + +DataGithubMembership.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` + +```java +import io.cdktn.providers.github.data_github_membership.DataGithubMembership; + +DataGithubMembership.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_membership.DataGithubMembership; + +DataGithubMembership.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_membership.DataGithubMembership; + +DataGithubMembership.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubMembership.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubMembership 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 DataGithubMembership to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubMembership that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/membership#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 DataGithubMembership 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| etag | java.lang.String | *No description.* | +| role | java.lang.String | *No description.* | +| state | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| organizationInput | java.lang.String | *No description.* | +| usernameInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| organization | java.lang.String | *No description.* | +| username | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `role`Required + +```java +public java.lang.String getRole(); +``` + +- *Type:* java.lang.String + +--- + +##### `state`Required + +```java +public java.lang.String getState(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `organizationInput`Optional + +```java +public java.lang.String getOrganizationInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `usernameInput`Optional + +```java +public java.lang.String getUsernameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `organization`Required + +```java +public java.lang.String getOrganization(); +``` + +- *Type:* java.lang.String + +--- + +##### `username`Required + +```java +public java.lang.String getUsername(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubMembershipConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_membership.DataGithubMembershipConfig; + +DataGithubMembershipConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .username(java.lang.String) +// .id(java.lang.String) +// .organization(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 | *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 | *No description.* | +| username | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/membership#username DataGithubMembership#username}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/membership#id DataGithubMembership#id}. | +| organization | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/membership#organization DataGithubMembership#organization}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `username`Required + +```java +public java.lang.String getUsername(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/membership#username DataGithubMembership#username}. + +--- + +##### `id`Optional + +```java +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/membership#id DataGithubMembership#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. + +--- + +##### `organization`Optional + +```java +public java.lang.String getOrganization(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/membership#organization DataGithubMembership#organization}. + +--- + + + diff --git a/docs/dataGithubOrganization.csharp.md b/docs/dataGithubOrganization.csharp.md new file mode 100644 index 000000000..433c8d79f --- /dev/null +++ b/docs/dataGithubOrganization.csharp.md @@ -0,0 +1,1120 @@ +# `dataGithubOrganization` Submodule + +## Constructs + +### DataGithubOrganization + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization github_organization}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganization(Construct Scope, string Id, DataGithubOrganizationConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubOrganizationConfig | *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:* DataGithubOrganizationConfig + +--- + +#### 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.* | +| ResetIgnoreArchivedRepos | *No description.* | +| ResetSummaryOnly | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetIgnoreArchivedRepos` + +```csharp +private void ResetIgnoreArchivedRepos() +``` + +##### `ResetSummaryOnly` + +```csharp +private void ResetSummaryOnly() +``` + +#### Static Functions + +| **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 ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganization.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganization.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganization.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganization.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubOrganization resource upon running "cdktn 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 DataGithubOrganization to import. + +--- + +###### `ImportFromId`Required + +- *Type:* 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 + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubOrganization to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| AdvancedSecurityEnabledForNewRepositories | Io.Cdktn.IResolvable | *No description.* | +| DefaultRepositoryPermission | string | *No description.* | +| DependabotAlertsEnabledForNewRepositories | Io.Cdktn.IResolvable | *No description.* | +| DependabotSecurityUpdatesEnabledForNewRepositories | Io.Cdktn.IResolvable | *No description.* | +| DependencyGraphEnabledForNewRepositories | Io.Cdktn.IResolvable | *No description.* | +| Description | string | *No description.* | +| Login | string | *No description.* | +| Members | string[] | *No description.* | +| MembersAllowedRepositoryCreationType | string | *No description.* | +| MembersCanCreateInternalRepositories | Io.Cdktn.IResolvable | *No description.* | +| MembersCanCreatePages | Io.Cdktn.IResolvable | *No description.* | +| MembersCanCreatePrivatePages | Io.Cdktn.IResolvable | *No description.* | +| MembersCanCreatePrivateRepositories | Io.Cdktn.IResolvable | *No description.* | +| MembersCanCreatePublicPages | Io.Cdktn.IResolvable | *No description.* | +| MembersCanCreatePublicRepositories | Io.Cdktn.IResolvable | *No description.* | +| MembersCanCreateRepositories | Io.Cdktn.IResolvable | *No description.* | +| MembersCanForkPrivateRepositories | Io.Cdktn.IResolvable | *No description.* | +| NodeId | string | *No description.* | +| Orgname | string | *No description.* | +| Plan | string | *No description.* | +| Repositories | string[] | *No description.* | +| SecretScanningEnabledForNewRepositories | Io.Cdktn.IResolvable | *No description.* | +| SecretScanningPushProtectionEnabledForNewRepositories | Io.Cdktn.IResolvable | *No description.* | +| TwoFactorRequirementEnabled | Io.Cdktn.IResolvable | *No description.* | +| Users | Io.Cdktn.StringMapList | *No description.* | +| WebCommitSignoffRequired | Io.Cdktn.IResolvable | *No description.* | +| IdInput | string | *No description.* | +| IgnoreArchivedReposInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| NameInput | string | *No description.* | +| SummaryOnlyInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| Id | string | *No description.* | +| IgnoreArchivedRepos | bool\|Io.Cdktn.IResolvable | *No description.* | +| Name | string | *No description.* | +| SummaryOnly | bool\|Io.Cdktn.IResolvable | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `AdvancedSecurityEnabledForNewRepositories`Required + +```csharp +public IResolvable AdvancedSecurityEnabledForNewRepositories { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `DefaultRepositoryPermission`Required + +```csharp +public string DefaultRepositoryPermission { get; } +``` + +- *Type:* string + +--- + +##### `DependabotAlertsEnabledForNewRepositories`Required + +```csharp +public IResolvable DependabotAlertsEnabledForNewRepositories { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `DependabotSecurityUpdatesEnabledForNewRepositories`Required + +```csharp +public IResolvable DependabotSecurityUpdatesEnabledForNewRepositories { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `DependencyGraphEnabledForNewRepositories`Required + +```csharp +public IResolvable DependencyGraphEnabledForNewRepositories { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `Login`Required + +```csharp +public string Login { get; } +``` + +- *Type:* string + +--- + +##### `Members`Required + +```csharp +public string[] Members { get; } +``` + +- *Type:* string[] + +--- + +##### `MembersAllowedRepositoryCreationType`Required + +```csharp +public string MembersAllowedRepositoryCreationType { get; } +``` + +- *Type:* string + +--- + +##### `MembersCanCreateInternalRepositories`Required + +```csharp +public IResolvable MembersCanCreateInternalRepositories { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `MembersCanCreatePages`Required + +```csharp +public IResolvable MembersCanCreatePages { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `MembersCanCreatePrivatePages`Required + +```csharp +public IResolvable MembersCanCreatePrivatePages { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `MembersCanCreatePrivateRepositories`Required + +```csharp +public IResolvable MembersCanCreatePrivateRepositories { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `MembersCanCreatePublicPages`Required + +```csharp +public IResolvable MembersCanCreatePublicPages { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `MembersCanCreatePublicRepositories`Required + +```csharp +public IResolvable MembersCanCreatePublicRepositories { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `MembersCanCreateRepositories`Required + +```csharp +public IResolvable MembersCanCreateRepositories { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `MembersCanForkPrivateRepositories`Required + +```csharp +public IResolvable MembersCanForkPrivateRepositories { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `NodeId`Required + +```csharp +public string NodeId { get; } +``` + +- *Type:* string + +--- + +##### `Orgname`Required + +```csharp +public string Orgname { get; } +``` + +- *Type:* string + +--- + +##### `Plan`Required + +```csharp +public string Plan { get; } +``` + +- *Type:* string + +--- + +##### `Repositories`Required + +```csharp +public string[] Repositories { get; } +``` + +- *Type:* string[] + +--- + +##### `SecretScanningEnabledForNewRepositories`Required + +```csharp +public IResolvable SecretScanningEnabledForNewRepositories { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `SecretScanningPushProtectionEnabledForNewRepositories`Required + +```csharp +public IResolvable SecretScanningPushProtectionEnabledForNewRepositories { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `TwoFactorRequirementEnabled`Required + +```csharp +public IResolvable TwoFactorRequirementEnabled { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `Users`Required + +```csharp +public StringMapList Users { get; } +``` + +- *Type:* Io.Cdktn.StringMapList + +--- + +##### `WebCommitSignoffRequired`Required + +```csharp +public IResolvable WebCommitSignoffRequired { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `IgnoreArchivedReposInput`Optional + +```csharp +public bool|IResolvable IgnoreArchivedReposInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `SummaryOnlyInput`Optional + +```csharp +public bool|IResolvable SummaryOnlyInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `IgnoreArchivedRepos`Required + +```csharp +public bool|IResolvable IgnoreArchivedRepos { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `SummaryOnly`Required + +```csharp +public bool|IResolvable SummaryOnly { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubOrganizationConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationConfig { + 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 Name, + string Id = null, + bool|IResolvable IgnoreArchivedRepos = null, + bool|IResolvable SummaryOnly = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Name | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization#name DataGithubOrganization#name}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization#id DataGithubOrganization#id}. | +| IgnoreArchivedRepos | bool\|Io.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 | bool\|Io.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}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Name`Required + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization#name DataGithubOrganization#name}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* 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. + +--- + +##### `IgnoreArchivedRepos`Optional + +```csharp +public bool|IResolvable IgnoreArchivedRepos { get; set; } +``` + +- *Type:* bool|Io.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`Optional + +```csharp +public bool|IResolvable SummaryOnly { get; set; } +``` + +- *Type:* bool|Io.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}. + +--- + + + diff --git a/docs/dataGithubOrganization.java.md b/docs/dataGithubOrganization.java.md new file mode 100644 index 000000000..93c09ffa0 --- /dev/null +++ b/docs/dataGithubOrganization.java.md @@ -0,0 +1,1213 @@ +# `dataGithubOrganization` Submodule + +## Constructs + +### DataGithubOrganization + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization github_organization}. + +#### Initializers + +```java +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) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .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 | *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 | *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}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `name`Required + +- *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}. + +--- + +##### `id`Optional + +- *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. + +--- + +##### `ignoreArchivedRepos`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/organization#ignore_archived_repos DataGithubOrganization#ignore_archived_repos}. + +--- + +##### `summaryOnly`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/organization#summary_only DataGithubOrganization#summary_only}. + +--- + +#### 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.* | +| resetIgnoreArchivedRepos | *No description.* | +| resetSummaryOnly | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetIgnoreArchivedRepos` + +```java +public void resetIgnoreArchivedRepos() +``` + +##### `resetSummaryOnly` + +```java +public void resetSummaryOnly() +``` + +#### Static Functions + +| **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 ". | + +--- + +##### `isConstruct` + +```java +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. + +###### `x`Required + +- *Type:* java.lang.Object + +Any object. + +--- + +##### `isTerraformElement` + +```java +import io.cdktn.providers.github.data_github_organization.DataGithubOrganization; + +DataGithubOrganization.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_organization.DataGithubOrganization; + +DataGithubOrganization.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +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 ". + +###### `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 DataGithubOrganization to import. + +--- + +###### `importFromId`Required + +- *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 + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.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 | io.cdktn.cdktn.TerraformStack | *No description.* | +| fqn | java.lang.String | *No description.* | +| friendlyUniqueId | java.lang.String | *No description.* | +| terraformMetaArguments | java.util.Map | *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 | *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 | *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 | *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.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `advancedSecurityEnabledForNewRepositories`Required + +```java +public IResolvable getAdvancedSecurityEnabledForNewRepositories(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `defaultRepositoryPermission`Required + +```java +public java.lang.String getDefaultRepositoryPermission(); +``` + +- *Type:* java.lang.String + +--- + +##### `dependabotAlertsEnabledForNewRepositories`Required + +```java +public IResolvable getDependabotAlertsEnabledForNewRepositories(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `dependabotSecurityUpdatesEnabledForNewRepositories`Required + +```java +public IResolvable getDependabotSecurityUpdatesEnabledForNewRepositories(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `dependencyGraphEnabledForNewRepositories`Required + +```java +public IResolvable getDependencyGraphEnabledForNewRepositories(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `login`Required + +```java +public java.lang.String getLogin(); +``` + +- *Type:* java.lang.String + +--- + +##### `members`Required + +```java +public java.util.List getMembers(); +``` + +- *Type:* java.util.List + +--- + +##### `membersAllowedRepositoryCreationType`Required + +```java +public java.lang.String getMembersAllowedRepositoryCreationType(); +``` + +- *Type:* java.lang.String + +--- + +##### `membersCanCreateInternalRepositories`Required + +```java +public IResolvable getMembersCanCreateInternalRepositories(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `membersCanCreatePages`Required + +```java +public IResolvable getMembersCanCreatePages(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `membersCanCreatePrivatePages`Required + +```java +public IResolvable getMembersCanCreatePrivatePages(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `membersCanCreatePrivateRepositories`Required + +```java +public IResolvable getMembersCanCreatePrivateRepositories(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `membersCanCreatePublicPages`Required + +```java +public IResolvable getMembersCanCreatePublicPages(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `membersCanCreatePublicRepositories`Required + +```java +public IResolvable getMembersCanCreatePublicRepositories(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `membersCanCreateRepositories`Required + +```java +public IResolvable getMembersCanCreateRepositories(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `membersCanForkPrivateRepositories`Required + +```java +public IResolvable getMembersCanForkPrivateRepositories(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `nodeId`Required + +```java +public java.lang.String getNodeId(); +``` + +- *Type:* java.lang.String + +--- + +##### `orgname`Required + +```java +public java.lang.String getOrgname(); +``` + +- *Type:* java.lang.String + +--- + +##### `plan`Required + +```java +public java.lang.String getPlan(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositories`Required + +```java +public java.util.List getRepositories(); +``` + +- *Type:* java.util.List + +--- + +##### `secretScanningEnabledForNewRepositories`Required + +```java +public IResolvable getSecretScanningEnabledForNewRepositories(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `secretScanningPushProtectionEnabledForNewRepositories`Required + +```java +public IResolvable getSecretScanningPushProtectionEnabledForNewRepositories(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `twoFactorRequirementEnabled`Required + +```java +public IResolvable getTwoFactorRequirementEnabled(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `users`Required + +```java +public StringMapList getUsers(); +``` + +- *Type:* io.cdktn.cdktn.StringMapList + +--- + +##### `webCommitSignoffRequired`Required + +```java +public IResolvable getWebCommitSignoffRequired(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `ignoreArchivedReposInput`Optional + +```java +public java.lang.Boolean|IResolvable getIgnoreArchivedReposInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `summaryOnlyInput`Optional + +```java +public java.lang.Boolean|IResolvable getSummaryOnlyInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `ignoreArchivedRepos`Required + +```java +public java.lang.Boolean|IResolvable getIgnoreArchivedRepos(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `summaryOnly`Required + +```java +public java.lang.Boolean|IResolvable getSummaryOnly(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubOrganizationConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization.DataGithubOrganizationConfig; + +DataGithubOrganizationConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .name(java.lang.String) +// .id(java.lang.String) +// .ignoreArchivedRepos(java.lang.Boolean|IResolvable) +// .summaryOnly(java.lang.Boolean|IResolvable) + .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 | *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 | *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}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `name`Required + +```java +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}. + +--- + +##### `id`Optional + +```java +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. + +--- + +##### `ignoreArchivedRepos`Optional + +```java +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}. + +--- + +##### `summaryOnly`Optional + +```java +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}. + +--- + + + diff --git a/docs/dataGithubOrganizationAppInstallations.csharp.md b/docs/dataGithubOrganizationAppInstallations.csharp.md new file mode 100644 index 000000000..9c42acc2c --- /dev/null +++ b/docs/dataGithubOrganizationAppInstallations.csharp.md @@ -0,0 +1,1296 @@ +# `dataGithubOrganizationAppInstallations` Submodule + +## Constructs + +### DataGithubOrganizationAppInstallations + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_app_installations github_organization_app_installations}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationAppInstallations(Construct Scope, string Id, DataGithubOrganizationAppInstallationsConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubOrganizationAppInstallationsConfig | *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`Optional + +- *Type:* DataGithubOrganizationAppInstallationsConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationAppInstallations resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationAppInstallations.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationAppInstallations.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationAppInstallations.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationAppInstallations.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubOrganizationAppInstallations resource upon running "cdktn 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 DataGithubOrganizationAppInstallations to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubOrganizationAppInstallations that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_app_installations#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubOrganizationAppInstallations to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Installations | DataGithubOrganizationAppInstallationsInstallationsList | *No description.* | +| IdInput | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Installations`Required + +```csharp +public DataGithubOrganizationAppInstallationsInstallationsList Installations { get; } +``` + +- *Type:* DataGithubOrganizationAppInstallationsInstallationsList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubOrganizationAppInstallationsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationAppInstallationsConfig { + 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 Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_app_installations#id DataGithubOrganizationAppInstallations#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_app_installations#id DataGithubOrganizationAppInstallations#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. + +--- + +### DataGithubOrganizationAppInstallationsInstallations + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationAppInstallationsInstallations { + +}; +``` + + +## Classes + +### DataGithubOrganizationAppInstallationsInstallationsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationAppInstallationsInstallationsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubOrganizationAppInstallationsInstallationsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubOrganizationAppInstallationsInstallationsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationAppInstallationsInstallationsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| AppId | double | *No description.* | +| AppSlug | string | *No description.* | +| ClientId | string | *No description.* | +| CreatedAt | string | *No description.* | +| Events | string[] | *No description.* | +| Id | double | *No description.* | +| Permissions | Io.Cdktn.StringMap | *No description.* | +| RepositorySelection | string | *No description.* | +| SingleFilePaths | string[] | *No description.* | +| Suspended | Io.Cdktn.IResolvable | *No description.* | +| TargetId | double | *No description.* | +| TargetType | string | *No description.* | +| UpdatedAt | string | *No description.* | +| InternalValue | DataGithubOrganizationAppInstallationsInstallations | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `AppId`Required + +```csharp +public double AppId { get; } +``` + +- *Type:* double + +--- + +##### `AppSlug`Required + +```csharp +public string AppSlug { get; } +``` + +- *Type:* string + +--- + +##### `ClientId`Required + +```csharp +public string ClientId { get; } +``` + +- *Type:* string + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Events`Required + +```csharp +public string[] Events { get; } +``` + +- *Type:* string[] + +--- + +##### `Id`Required + +```csharp +public double Id { get; } +``` + +- *Type:* double + +--- + +##### `Permissions`Required + +```csharp +public StringMap Permissions { get; } +``` + +- *Type:* Io.Cdktn.StringMap + +--- + +##### `RepositorySelection`Required + +```csharp +public string RepositorySelection { get; } +``` + +- *Type:* string + +--- + +##### `SingleFilePaths`Required + +```csharp +public string[] SingleFilePaths { get; } +``` + +- *Type:* string[] + +--- + +##### `Suspended`Required + +```csharp +public IResolvable Suspended { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `TargetId`Required + +```csharp +public double TargetId { get; } +``` + +- *Type:* double + +--- + +##### `TargetType`Required + +```csharp +public string TargetType { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubOrganizationAppInstallationsInstallations InternalValue { get; } +``` + +- *Type:* DataGithubOrganizationAppInstallationsInstallations + +--- + + + diff --git a/docs/dataGithubOrganizationAppInstallations.java.md b/docs/dataGithubOrganizationAppInstallations.java.md new file mode 100644 index 000000000..2a1080ed8 --- /dev/null +++ b/docs/dataGithubOrganizationAppInstallations.java.md @@ -0,0 +1,1358 @@ +# `dataGithubOrganizationAppInstallations` Submodule + +## Constructs + +### DataGithubOrganizationAppInstallations + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_app_installations github_organization_app_installations}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_app_installations.DataGithubOrganizationAppInstallations; + +DataGithubOrganizationAppInstallations.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_app_installations#id DataGithubOrganizationAppInstallations#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_app_installations#id DataGithubOrganizationAppInstallations#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationAppInstallations resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_organization_app_installations.DataGithubOrganizationAppInstallations; + +DataGithubOrganizationAppInstallations.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` + +```java +import io.cdktn.providers.github.data_github_organization_app_installations.DataGithubOrganizationAppInstallations; + +DataGithubOrganizationAppInstallations.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_organization_app_installations.DataGithubOrganizationAppInstallations; + +DataGithubOrganizationAppInstallations.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_organization_app_installations.DataGithubOrganizationAppInstallations; + +DataGithubOrganizationAppInstallations.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubOrganizationAppInstallations.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubOrganizationAppInstallations 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 DataGithubOrganizationAppInstallations to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubOrganizationAppInstallations that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_app_installations#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 DataGithubOrganizationAppInstallations 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| installations | DataGithubOrganizationAppInstallationsInstallationsList | *No description.* | +| idInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `installations`Required + +```java +public DataGithubOrganizationAppInstallationsInstallationsList getInstallations(); +``` + +- *Type:* DataGithubOrganizationAppInstallationsInstallationsList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubOrganizationAppInstallationsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_app_installations.DataGithubOrganizationAppInstallationsConfig; + +DataGithubOrganizationAppInstallationsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_app_installations#id DataGithubOrganizationAppInstallations#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Optional + +```java +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_app_installations#id DataGithubOrganizationAppInstallations#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. + +--- + +### DataGithubOrganizationAppInstallationsInstallations + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_app_installations.DataGithubOrganizationAppInstallationsInstallations; + +DataGithubOrganizationAppInstallationsInstallations.builder() + .build(); +``` + + +## Classes + +### DataGithubOrganizationAppInstallationsInstallationsList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_app_installations.DataGithubOrganizationAppInstallationsInstallationsList; + +new DataGithubOrganizationAppInstallationsInstallationsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubOrganizationAppInstallationsInstallationsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubOrganizationAppInstallationsInstallationsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_app_installations.DataGithubOrganizationAppInstallationsInstallationsOutputReference; + +new DataGithubOrganizationAppInstallationsInstallationsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| appId | java.lang.Number | *No description.* | +| appSlug | java.lang.String | *No description.* | +| clientId | java.lang.String | *No description.* | +| createdAt | java.lang.String | *No description.* | +| events | java.util.List | *No description.* | +| id | java.lang.Number | *No description.* | +| permissions | io.cdktn.cdktn.StringMap | *No description.* | +| repositorySelection | java.lang.String | *No description.* | +| singleFilePaths | java.util.List | *No description.* | +| suspended | io.cdktn.cdktn.IResolvable | *No description.* | +| targetId | java.lang.Number | *No description.* | +| targetType | java.lang.String | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| internalValue | DataGithubOrganizationAppInstallationsInstallations | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `appId`Required + +```java +public java.lang.Number getAppId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `appSlug`Required + +```java +public java.lang.String getAppSlug(); +``` + +- *Type:* java.lang.String + +--- + +##### `clientId`Required + +```java +public java.lang.String getClientId(); +``` + +- *Type:* java.lang.String + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `events`Required + +```java +public java.util.List getEvents(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Required + +```java +public java.lang.Number getId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `permissions`Required + +```java +public StringMap getPermissions(); +``` + +- *Type:* io.cdktn.cdktn.StringMap + +--- + +##### `repositorySelection`Required + +```java +public java.lang.String getRepositorySelection(); +``` + +- *Type:* java.lang.String + +--- + +##### `singleFilePaths`Required + +```java +public java.util.List getSingleFilePaths(); +``` + +- *Type:* java.util.List + +--- + +##### `suspended`Required + +```java +public IResolvable getSuspended(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `targetId`Required + +```java +public java.lang.Number getTargetId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `targetType`Required + +```java +public java.lang.String getTargetType(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubOrganizationAppInstallationsInstallations getInternalValue(); +``` + +- *Type:* DataGithubOrganizationAppInstallationsInstallations + +--- + + + diff --git a/docs/dataGithubOrganizationCustomProperties.csharp.md b/docs/dataGithubOrganizationCustomProperties.csharp.md new file mode 100644 index 000000000..3aa0db2b2 --- /dev/null +++ b/docs/dataGithubOrganizationCustomProperties.csharp.md @@ -0,0 +1,1006 @@ +# `dataGithubOrganizationCustomProperties` Submodule + +## Constructs + +### DataGithubOrganizationCustomProperties + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties github_organization_custom_properties}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationCustomProperties(Construct Scope, string Id, DataGithubOrganizationCustomPropertiesConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubOrganizationCustomPropertiesConfig | *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:* DataGithubOrganizationCustomPropertiesConfig + +--- + +#### 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.* | +| ResetAllowedValues | *No description.* | +| ResetDefaultValue | *No description.* | +| ResetDescription | *No description.* | +| ResetId | *No description.* | +| ResetRequired | *No description.* | +| ResetValuesEditableBy | *No description.* | +| ResetValueType | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetAllowedValues` + +```csharp +private void ResetAllowedValues() +``` + +##### `ResetDefaultValue` + +```csharp +private void ResetDefaultValue() +``` + +##### `ResetDescription` + +```csharp +private void ResetDescription() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetRequired` + +```csharp +private void ResetRequired() +``` + +##### `ResetValuesEditableBy` + +```csharp +private void ResetValuesEditableBy() +``` + +##### `ResetValueType` + +```csharp +private void ResetValueType() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationCustomProperties resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationCustomProperties.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationCustomProperties.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationCustomProperties.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationCustomProperties.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubOrganizationCustomProperties resource upon running "cdktn 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 DataGithubOrganizationCustomProperties to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubOrganizationCustomProperties that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubOrganizationCustomProperties to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| AllowedValuesInput | string[] | *No description.* | +| DefaultValueInput | string | *No description.* | +| DescriptionInput | string | *No description.* | +| IdInput | string | *No description.* | +| PropertyNameInput | string | *No description.* | +| RequiredInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| ValuesEditableByInput | string | *No description.* | +| ValueTypeInput | string | *No description.* | +| AllowedValues | string[] | *No description.* | +| DefaultValue | string | *No description.* | +| Description | string | *No description.* | +| Id | string | *No description.* | +| PropertyName | string | *No description.* | +| Required | bool\|Io.Cdktn.IResolvable | *No description.* | +| ValuesEditableBy | string | *No description.* | +| ValueType | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `AllowedValuesInput`Optional + +```csharp +public string[] AllowedValuesInput { get; } +``` + +- *Type:* string[] + +--- + +##### `DefaultValueInput`Optional + +```csharp +public string DefaultValueInput { get; } +``` + +- *Type:* string + +--- + +##### `DescriptionInput`Optional + +```csharp +public string DescriptionInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `PropertyNameInput`Optional + +```csharp +public string PropertyNameInput { get; } +``` + +- *Type:* string + +--- + +##### `RequiredInput`Optional + +```csharp +public bool|IResolvable RequiredInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ValuesEditableByInput`Optional + +```csharp +public string ValuesEditableByInput { get; } +``` + +- *Type:* string + +--- + +##### `ValueTypeInput`Optional + +```csharp +public string ValueTypeInput { get; } +``` + +- *Type:* string + +--- + +##### `AllowedValues`Required + +```csharp +public string[] AllowedValues { get; } +``` + +- *Type:* string[] + +--- + +##### `DefaultValue`Required + +```csharp +public string DefaultValue { get; } +``` + +- *Type:* string + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `PropertyName`Required + +```csharp +public string PropertyName { get; } +``` + +- *Type:* string + +--- + +##### `Required`Required + +```csharp +public bool|IResolvable Required { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ValuesEditableBy`Required + +```csharp +public string ValuesEditableBy { get; } +``` + +- *Type:* string + +--- + +##### `ValueType`Required + +```csharp +public string ValueType { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubOrganizationCustomPropertiesConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationCustomPropertiesConfig { + 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 PropertyName, + string[] AllowedValues = null, + string DefaultValue = null, + string Description = null, + string Id = null, + bool|IResolvable Required = null, + string ValuesEditableBy = null, + string ValueType = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| PropertyName | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#property_name DataGithubOrganizationCustomProperties#property_name}. | +| AllowedValues | string[] | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#allowed_values DataGithubOrganizationCustomProperties#allowed_values}. | +| DefaultValue | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#default_value DataGithubOrganizationCustomProperties#default_value}. | +| Description | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#description DataGithubOrganizationCustomProperties#description}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#id DataGithubOrganizationCustomProperties#id}. | +| Required | bool\|Io.Cdktn.IResolvable | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#required DataGithubOrganizationCustomProperties#required}. | +| ValuesEditableBy | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#values_editable_by DataGithubOrganizationCustomProperties#values_editable_by}. | +| ValueType | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#value_type DataGithubOrganizationCustomProperties#value_type}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `PropertyName`Required + +```csharp +public string PropertyName { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#property_name DataGithubOrganizationCustomProperties#property_name}. + +--- + +##### `AllowedValues`Optional + +```csharp +public string[] AllowedValues { get; set; } +``` + +- *Type:* string[] + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#allowed_values DataGithubOrganizationCustomProperties#allowed_values}. + +--- + +##### `DefaultValue`Optional + +```csharp +public string DefaultValue { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#default_value DataGithubOrganizationCustomProperties#default_value}. + +--- + +##### `Description`Optional + +```csharp +public string Description { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#description DataGithubOrganizationCustomProperties#description}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#id DataGithubOrganizationCustomProperties#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. + +--- + +##### `Required`Optional + +```csharp +public bool|IResolvable Required { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#required DataGithubOrganizationCustomProperties#required}. + +--- + +##### `ValuesEditableBy`Optional + +```csharp +public string ValuesEditableBy { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#values_editable_by DataGithubOrganizationCustomProperties#values_editable_by}. + +--- + +##### `ValueType`Optional + +```csharp +public string ValueType { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#value_type DataGithubOrganizationCustomProperties#value_type}. + +--- + + + diff --git a/docs/dataGithubOrganizationCustomProperties.java.md b/docs/dataGithubOrganizationCustomProperties.java.md new file mode 100644 index 000000000..fef21a713 --- /dev/null +++ b/docs/dataGithubOrganizationCustomProperties.java.md @@ -0,0 +1,1139 @@ +# `dataGithubOrganizationCustomProperties` Submodule + +## Constructs + +### DataGithubOrganizationCustomProperties + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties github_organization_custom_properties}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_custom_properties.DataGithubOrganizationCustomProperties; + +DataGithubOrganizationCustomProperties.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .propertyName(java.lang.String) +// .allowedValues(java.util.List) +// .defaultValue(java.lang.String) +// .description(java.lang.String) +// .id(java.lang.String) +// .required(java.lang.Boolean|IResolvable) +// .valuesEditableBy(java.lang.String) +// .valueType(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 | *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 | *No description.* | +| propertyName | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#property_name DataGithubOrganizationCustomProperties#property_name}. | +| allowedValues | java.util.List | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#allowed_values DataGithubOrganizationCustomProperties#allowed_values}. | +| defaultValue | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#default_value DataGithubOrganizationCustomProperties#default_value}. | +| description | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#description DataGithubOrganizationCustomProperties#description}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#id DataGithubOrganizationCustomProperties#id}. | +| required | 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_custom_properties#required DataGithubOrganizationCustomProperties#required}. | +| valuesEditableBy | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#values_editable_by DataGithubOrganizationCustomProperties#values_editable_by}. | +| valueType | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#value_type DataGithubOrganizationCustomProperties#value_type}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `propertyName`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#property_name DataGithubOrganizationCustomProperties#property_name}. + +--- + +##### `allowedValues`Optional + +- *Type:* java.util.List + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#allowed_values DataGithubOrganizationCustomProperties#allowed_values}. + +--- + +##### `defaultValue`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#default_value DataGithubOrganizationCustomProperties#default_value}. + +--- + +##### `description`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#description DataGithubOrganizationCustomProperties#description}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#id DataGithubOrganizationCustomProperties#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. + +--- + +##### `required`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/organization_custom_properties#required DataGithubOrganizationCustomProperties#required}. + +--- + +##### `valuesEditableBy`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#values_editable_by DataGithubOrganizationCustomProperties#values_editable_by}. + +--- + +##### `valueType`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#value_type DataGithubOrganizationCustomProperties#value_type}. + +--- + +#### 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.* | +| resetAllowedValues | *No description.* | +| resetDefaultValue | *No description.* | +| resetDescription | *No description.* | +| resetId | *No description.* | +| resetRequired | *No description.* | +| resetValuesEditableBy | *No description.* | +| resetValueType | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetAllowedValues` + +```java +public void resetAllowedValues() +``` + +##### `resetDefaultValue` + +```java +public void resetDefaultValue() +``` + +##### `resetDescription` + +```java +public void resetDescription() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetRequired` + +```java +public void resetRequired() +``` + +##### `resetValuesEditableBy` + +```java +public void resetValuesEditableBy() +``` + +##### `resetValueType` + +```java +public void resetValueType() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationCustomProperties resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_organization_custom_properties.DataGithubOrganizationCustomProperties; + +DataGithubOrganizationCustomProperties.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` + +```java +import io.cdktn.providers.github.data_github_organization_custom_properties.DataGithubOrganizationCustomProperties; + +DataGithubOrganizationCustomProperties.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_organization_custom_properties.DataGithubOrganizationCustomProperties; + +DataGithubOrganizationCustomProperties.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_organization_custom_properties.DataGithubOrganizationCustomProperties; + +DataGithubOrganizationCustomProperties.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubOrganizationCustomProperties.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubOrganizationCustomProperties 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 DataGithubOrganizationCustomProperties to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubOrganizationCustomProperties that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#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 DataGithubOrganizationCustomProperties 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| allowedValuesInput | java.util.List | *No description.* | +| defaultValueInput | java.lang.String | *No description.* | +| descriptionInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| propertyNameInput | java.lang.String | *No description.* | +| requiredInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| valuesEditableByInput | java.lang.String | *No description.* | +| valueTypeInput | java.lang.String | *No description.* | +| allowedValues | java.util.List | *No description.* | +| defaultValue | java.lang.String | *No description.* | +| description | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| propertyName | java.lang.String | *No description.* | +| required | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| valuesEditableBy | java.lang.String | *No description.* | +| valueType | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `allowedValuesInput`Optional + +```java +public java.util.List getAllowedValuesInput(); +``` + +- *Type:* java.util.List + +--- + +##### `defaultValueInput`Optional + +```java +public java.lang.String getDefaultValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `descriptionInput`Optional + +```java +public java.lang.String getDescriptionInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `propertyNameInput`Optional + +```java +public java.lang.String getPropertyNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `requiredInput`Optional + +```java +public java.lang.Boolean|IResolvable getRequiredInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `valuesEditableByInput`Optional + +```java +public java.lang.String getValuesEditableByInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `valueTypeInput`Optional + +```java +public java.lang.String getValueTypeInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `allowedValues`Required + +```java +public java.util.List getAllowedValues(); +``` + +- *Type:* java.util.List + +--- + +##### `defaultValue`Required + +```java +public java.lang.String getDefaultValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `propertyName`Required + +```java +public java.lang.String getPropertyName(); +``` + +- *Type:* java.lang.String + +--- + +##### `required`Required + +```java +public java.lang.Boolean|IResolvable getRequired(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `valuesEditableBy`Required + +```java +public java.lang.String getValuesEditableBy(); +``` + +- *Type:* java.lang.String + +--- + +##### `valueType`Required + +```java +public java.lang.String getValueType(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubOrganizationCustomPropertiesConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_custom_properties.DataGithubOrganizationCustomPropertiesConfig; + +DataGithubOrganizationCustomPropertiesConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .propertyName(java.lang.String) +// .allowedValues(java.util.List) +// .defaultValue(java.lang.String) +// .description(java.lang.String) +// .id(java.lang.String) +// .required(java.lang.Boolean|IResolvable) +// .valuesEditableBy(java.lang.String) +// .valueType(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 | *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 | *No description.* | +| propertyName | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#property_name DataGithubOrganizationCustomProperties#property_name}. | +| allowedValues | java.util.List | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#allowed_values DataGithubOrganizationCustomProperties#allowed_values}. | +| defaultValue | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#default_value DataGithubOrganizationCustomProperties#default_value}. | +| description | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#description DataGithubOrganizationCustomProperties#description}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#id DataGithubOrganizationCustomProperties#id}. | +| required | 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_custom_properties#required DataGithubOrganizationCustomProperties#required}. | +| valuesEditableBy | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#values_editable_by DataGithubOrganizationCustomProperties#values_editable_by}. | +| valueType | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#value_type DataGithubOrganizationCustomProperties#value_type}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `propertyName`Required + +```java +public java.lang.String getPropertyName(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#property_name DataGithubOrganizationCustomProperties#property_name}. + +--- + +##### `allowedValues`Optional + +```java +public java.util.List getAllowedValues(); +``` + +- *Type:* java.util.List + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#allowed_values DataGithubOrganizationCustomProperties#allowed_values}. + +--- + +##### `defaultValue`Optional + +```java +public java.lang.String getDefaultValue(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#default_value DataGithubOrganizationCustomProperties#default_value}. + +--- + +##### `description`Optional + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#description DataGithubOrganizationCustomProperties#description}. + +--- + +##### `id`Optional + +```java +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_custom_properties#id DataGithubOrganizationCustomProperties#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. + +--- + +##### `required`Optional + +```java +public java.lang.Boolean|IResolvable getRequired(); +``` + +- *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_custom_properties#required DataGithubOrganizationCustomProperties#required}. + +--- + +##### `valuesEditableBy`Optional + +```java +public java.lang.String getValuesEditableBy(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#values_editable_by DataGithubOrganizationCustomProperties#values_editable_by}. + +--- + +##### `valueType`Optional + +```java +public java.lang.String getValueType(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_properties#value_type DataGithubOrganizationCustomProperties#value_type}. + +--- + + + diff --git a/docs/dataGithubOrganizationCustomRole.csharp.md b/docs/dataGithubOrganizationCustomRole.csharp.md new file mode 100644 index 000000000..c9b369d37 --- /dev/null +++ b/docs/dataGithubOrganizationCustomRole.csharp.md @@ -0,0 +1,781 @@ +# `dataGithubOrganizationCustomRole` Submodule + +## Constructs + +### DataGithubOrganizationCustomRole + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_role github_organization_custom_role}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationCustomRole(Construct Scope, string Id, DataGithubOrganizationCustomRoleConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubOrganizationCustomRoleConfig | *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:* DataGithubOrganizationCustomRoleConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationCustomRole resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationCustomRole.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationCustomRole.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationCustomRole.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationCustomRole.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubOrganizationCustomRole resource upon running "cdktn 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 DataGithubOrganizationCustomRole to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubOrganizationCustomRole that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_role#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubOrganizationCustomRole to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| BaseRole | string | *No description.* | +| Description | string | *No description.* | +| Permissions | string[] | *No description.* | +| IdInput | string | *No description.* | +| NameInput | string | *No description.* | +| Id | string | *No description.* | +| Name | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `BaseRole`Required + +```csharp +public string BaseRole { get; } +``` + +- *Type:* string + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `Permissions`Required + +```csharp +public string[] Permissions { get; } +``` + +- *Type:* string[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubOrganizationCustomRoleConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationCustomRoleConfig { + 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 Name, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Name | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_role#name DataGithubOrganizationCustomRole#name}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_role#id DataGithubOrganizationCustomRole#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Name`Required + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_role#name DataGithubOrganizationCustomRole#name}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_role#id DataGithubOrganizationCustomRole#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. + +--- + + + diff --git a/docs/dataGithubOrganizationCustomRole.java.md b/docs/dataGithubOrganizationCustomRole.java.md new file mode 100644 index 000000000..1df8a9177 --- /dev/null +++ b/docs/dataGithubOrganizationCustomRole.java.md @@ -0,0 +1,854 @@ +# `dataGithubOrganizationCustomRole` Submodule + +## Constructs + +### DataGithubOrganizationCustomRole + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_role github_organization_custom_role}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_custom_role.DataGithubOrganizationCustomRole; + +DataGithubOrganizationCustomRole.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .name(java.lang.String) +// .id(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 | *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 | *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_custom_role#name DataGithubOrganizationCustomRole#name}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_role#id DataGithubOrganizationCustomRole#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `name`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_role#name DataGithubOrganizationCustomRole#name}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_role#id DataGithubOrganizationCustomRole#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationCustomRole resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_organization_custom_role.DataGithubOrganizationCustomRole; + +DataGithubOrganizationCustomRole.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` + +```java +import io.cdktn.providers.github.data_github_organization_custom_role.DataGithubOrganizationCustomRole; + +DataGithubOrganizationCustomRole.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_organization_custom_role.DataGithubOrganizationCustomRole; + +DataGithubOrganizationCustomRole.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_organization_custom_role.DataGithubOrganizationCustomRole; + +DataGithubOrganizationCustomRole.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubOrganizationCustomRole.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubOrganizationCustomRole 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 DataGithubOrganizationCustomRole to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubOrganizationCustomRole that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_role#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 DataGithubOrganizationCustomRole 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| baseRole | java.lang.String | *No description.* | +| description | java.lang.String | *No description.* | +| permissions | java.util.List | *No description.* | +| idInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `baseRole`Required + +```java +public java.lang.String getBaseRole(); +``` + +- *Type:* java.lang.String + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `permissions`Required + +```java +public java.util.List getPermissions(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubOrganizationCustomRoleConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_custom_role.DataGithubOrganizationCustomRoleConfig; + +DataGithubOrganizationCustomRoleConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .name(java.lang.String) +// .id(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 | *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 | *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_custom_role#name DataGithubOrganizationCustomRole#name}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_custom_role#id DataGithubOrganizationCustomRole#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `name`Required + +```java +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_custom_role#name DataGithubOrganizationCustomRole#name}. + +--- + +##### `id`Optional + +```java +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_custom_role#id DataGithubOrganizationCustomRole#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. + +--- + + + diff --git a/docs/dataGithubOrganizationExternalIdentities.csharp.md b/docs/dataGithubOrganizationExternalIdentities.csharp.md new file mode 100644 index 000000000..3f6f2e2de --- /dev/null +++ b/docs/dataGithubOrganizationExternalIdentities.csharp.md @@ -0,0 +1,1186 @@ +# `dataGithubOrganizationExternalIdentities` Submodule + +## Constructs + +### DataGithubOrganizationExternalIdentities + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_external_identities github_organization_external_identities}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationExternalIdentities(Construct Scope, string Id, DataGithubOrganizationExternalIdentitiesConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubOrganizationExternalIdentitiesConfig | *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`Optional + +- *Type:* DataGithubOrganizationExternalIdentitiesConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationExternalIdentities resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationExternalIdentities.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationExternalIdentities.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationExternalIdentities.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationExternalIdentities.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubOrganizationExternalIdentities resource upon running "cdktn 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 DataGithubOrganizationExternalIdentities to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubOrganizationExternalIdentities that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_external_identities#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubOrganizationExternalIdentities to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Identities | DataGithubOrganizationExternalIdentitiesIdentitiesList | *No description.* | +| IdInput | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Identities`Required + +```csharp +public DataGithubOrganizationExternalIdentitiesIdentitiesList Identities { get; } +``` + +- *Type:* DataGithubOrganizationExternalIdentitiesIdentitiesList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubOrganizationExternalIdentitiesConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationExternalIdentitiesConfig { + 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 Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_external_identities#id DataGithubOrganizationExternalIdentities#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_external_identities#id DataGithubOrganizationExternalIdentities#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. + +--- + +### DataGithubOrganizationExternalIdentitiesIdentities + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationExternalIdentitiesIdentities { + +}; +``` + + +## Classes + +### DataGithubOrganizationExternalIdentitiesIdentitiesList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationExternalIdentitiesIdentitiesList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubOrganizationExternalIdentitiesIdentitiesOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubOrganizationExternalIdentitiesIdentitiesOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationExternalIdentitiesIdentitiesOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Login | string | *No description.* | +| SamlIdentity | Io.Cdktn.StringMap | *No description.* | +| ScimIdentity | Io.Cdktn.StringMap | *No description.* | +| InternalValue | DataGithubOrganizationExternalIdentitiesIdentities | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Login`Required + +```csharp +public string Login { get; } +``` + +- *Type:* string + +--- + +##### `SamlIdentity`Required + +```csharp +public StringMap SamlIdentity { get; } +``` + +- *Type:* Io.Cdktn.StringMap + +--- + +##### `ScimIdentity`Required + +```csharp +public StringMap ScimIdentity { get; } +``` + +- *Type:* Io.Cdktn.StringMap + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubOrganizationExternalIdentitiesIdentities InternalValue { get; } +``` + +- *Type:* DataGithubOrganizationExternalIdentitiesIdentities + +--- + + + diff --git a/docs/dataGithubOrganizationExternalIdentities.java.md b/docs/dataGithubOrganizationExternalIdentities.java.md new file mode 100644 index 000000000..3f26e30e1 --- /dev/null +++ b/docs/dataGithubOrganizationExternalIdentities.java.md @@ -0,0 +1,1248 @@ +# `dataGithubOrganizationExternalIdentities` Submodule + +## Constructs + +### DataGithubOrganizationExternalIdentities + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_external_identities github_organization_external_identities}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_external_identities.DataGithubOrganizationExternalIdentities; + +DataGithubOrganizationExternalIdentities.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_external_identities#id DataGithubOrganizationExternalIdentities#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_external_identities#id DataGithubOrganizationExternalIdentities#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationExternalIdentities resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_organization_external_identities.DataGithubOrganizationExternalIdentities; + +DataGithubOrganizationExternalIdentities.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` + +```java +import io.cdktn.providers.github.data_github_organization_external_identities.DataGithubOrganizationExternalIdentities; + +DataGithubOrganizationExternalIdentities.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_organization_external_identities.DataGithubOrganizationExternalIdentities; + +DataGithubOrganizationExternalIdentities.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_organization_external_identities.DataGithubOrganizationExternalIdentities; + +DataGithubOrganizationExternalIdentities.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubOrganizationExternalIdentities.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubOrganizationExternalIdentities 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 DataGithubOrganizationExternalIdentities to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubOrganizationExternalIdentities that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_external_identities#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 DataGithubOrganizationExternalIdentities 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| identities | DataGithubOrganizationExternalIdentitiesIdentitiesList | *No description.* | +| idInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `identities`Required + +```java +public DataGithubOrganizationExternalIdentitiesIdentitiesList getIdentities(); +``` + +- *Type:* DataGithubOrganizationExternalIdentitiesIdentitiesList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubOrganizationExternalIdentitiesConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_external_identities.DataGithubOrganizationExternalIdentitiesConfig; + +DataGithubOrganizationExternalIdentitiesConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_external_identities#id DataGithubOrganizationExternalIdentities#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Optional + +```java +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_external_identities#id DataGithubOrganizationExternalIdentities#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. + +--- + +### DataGithubOrganizationExternalIdentitiesIdentities + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_external_identities.DataGithubOrganizationExternalIdentitiesIdentities; + +DataGithubOrganizationExternalIdentitiesIdentities.builder() + .build(); +``` + + +## Classes + +### DataGithubOrganizationExternalIdentitiesIdentitiesList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_external_identities.DataGithubOrganizationExternalIdentitiesIdentitiesList; + +new DataGithubOrganizationExternalIdentitiesIdentitiesList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubOrganizationExternalIdentitiesIdentitiesOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubOrganizationExternalIdentitiesIdentitiesOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_external_identities.DataGithubOrganizationExternalIdentitiesIdentitiesOutputReference; + +new DataGithubOrganizationExternalIdentitiesIdentitiesOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| login | java.lang.String | *No description.* | +| samlIdentity | io.cdktn.cdktn.StringMap | *No description.* | +| scimIdentity | io.cdktn.cdktn.StringMap | *No description.* | +| internalValue | DataGithubOrganizationExternalIdentitiesIdentities | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `login`Required + +```java +public java.lang.String getLogin(); +``` + +- *Type:* java.lang.String + +--- + +##### `samlIdentity`Required + +```java +public StringMap getSamlIdentity(); +``` + +- *Type:* io.cdktn.cdktn.StringMap + +--- + +##### `scimIdentity`Required + +```java +public StringMap getScimIdentity(); +``` + +- *Type:* io.cdktn.cdktn.StringMap + +--- + +##### `internalValue`Optional + +```java +public DataGithubOrganizationExternalIdentitiesIdentities getInternalValue(); +``` + +- *Type:* DataGithubOrganizationExternalIdentitiesIdentities + +--- + + + diff --git a/docs/dataGithubOrganizationIpAllowList.csharp.md b/docs/dataGithubOrganizationIpAllowList.csharp.md new file mode 100644 index 000000000..8b030deeb --- /dev/null +++ b/docs/dataGithubOrganizationIpAllowList.csharp.md @@ -0,0 +1,1219 @@ +# `dataGithubOrganizationIpAllowList` Submodule + +## Constructs + +### DataGithubOrganizationIpAllowList + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_ip_allow_list github_organization_ip_allow_list}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationIpAllowList(Construct Scope, string Id, DataGithubOrganizationIpAllowListConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubOrganizationIpAllowListConfig | *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`Optional + +- *Type:* DataGithubOrganizationIpAllowListConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationIpAllowList resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationIpAllowList.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationIpAllowList.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationIpAllowList.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationIpAllowList.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubOrganizationIpAllowList resource upon running "cdktn 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 DataGithubOrganizationIpAllowList to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubOrganizationIpAllowList that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_ip_allow_list#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubOrganizationIpAllowList to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| IpAllowList | DataGithubOrganizationIpAllowListIpAllowListStructList | *No description.* | +| IdInput | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `IpAllowList`Required + +```csharp +public DataGithubOrganizationIpAllowListIpAllowListStructList IpAllowList { get; } +``` + +- *Type:* DataGithubOrganizationIpAllowListIpAllowListStructList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubOrganizationIpAllowListConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationIpAllowListConfig { + 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 Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_ip_allow_list#id DataGithubOrganizationIpAllowList#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_ip_allow_list#id DataGithubOrganizationIpAllowList#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. + +--- + +### DataGithubOrganizationIpAllowListIpAllowListStruct + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationIpAllowListIpAllowListStruct { + +}; +``` + + +## Classes + +### DataGithubOrganizationIpAllowListIpAllowListStructList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationIpAllowListIpAllowListStructList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubOrganizationIpAllowListIpAllowListStructOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubOrganizationIpAllowListIpAllowListStructOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationIpAllowListIpAllowListStructOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| AllowListValue | string | *No description.* | +| CreatedAt | string | *No description.* | +| Id | string | *No description.* | +| IsActive | Io.Cdktn.IResolvable | *No description.* | +| Name | string | *No description.* | +| UpdatedAt | string | *No description.* | +| InternalValue | DataGithubOrganizationIpAllowListIpAllowListStruct | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `AllowListValue`Required + +```csharp +public string AllowListValue { get; } +``` + +- *Type:* string + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `IsActive`Required + +```csharp +public IResolvable IsActive { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubOrganizationIpAllowListIpAllowListStruct InternalValue { get; } +``` + +- *Type:* DataGithubOrganizationIpAllowListIpAllowListStruct + +--- + + + diff --git a/docs/dataGithubOrganizationIpAllowList.java.md b/docs/dataGithubOrganizationIpAllowList.java.md new file mode 100644 index 000000000..c24057484 --- /dev/null +++ b/docs/dataGithubOrganizationIpAllowList.java.md @@ -0,0 +1,1281 @@ +# `dataGithubOrganizationIpAllowList` Submodule + +## Constructs + +### DataGithubOrganizationIpAllowList + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_ip_allow_list github_organization_ip_allow_list}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_ip_allow_list.DataGithubOrganizationIpAllowList; + +DataGithubOrganizationIpAllowList.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_ip_allow_list#id DataGithubOrganizationIpAllowList#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_ip_allow_list#id DataGithubOrganizationIpAllowList#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationIpAllowList resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_organization_ip_allow_list.DataGithubOrganizationIpAllowList; + +DataGithubOrganizationIpAllowList.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` + +```java +import io.cdktn.providers.github.data_github_organization_ip_allow_list.DataGithubOrganizationIpAllowList; + +DataGithubOrganizationIpAllowList.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_organization_ip_allow_list.DataGithubOrganizationIpAllowList; + +DataGithubOrganizationIpAllowList.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_organization_ip_allow_list.DataGithubOrganizationIpAllowList; + +DataGithubOrganizationIpAllowList.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubOrganizationIpAllowList.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubOrganizationIpAllowList 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 DataGithubOrganizationIpAllowList to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubOrganizationIpAllowList that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_ip_allow_list#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 DataGithubOrganizationIpAllowList 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| ipAllowList | DataGithubOrganizationIpAllowListIpAllowListStructList | *No description.* | +| idInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `ipAllowList`Required + +```java +public DataGithubOrganizationIpAllowListIpAllowListStructList getIpAllowList(); +``` + +- *Type:* DataGithubOrganizationIpAllowListIpAllowListStructList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubOrganizationIpAllowListConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_ip_allow_list.DataGithubOrganizationIpAllowListConfig; + +DataGithubOrganizationIpAllowListConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_ip_allow_list#id DataGithubOrganizationIpAllowList#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Optional + +```java +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_ip_allow_list#id DataGithubOrganizationIpAllowList#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. + +--- + +### DataGithubOrganizationIpAllowListIpAllowListStruct + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_ip_allow_list.DataGithubOrganizationIpAllowListIpAllowListStruct; + +DataGithubOrganizationIpAllowListIpAllowListStruct.builder() + .build(); +``` + + +## Classes + +### DataGithubOrganizationIpAllowListIpAllowListStructList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_ip_allow_list.DataGithubOrganizationIpAllowListIpAllowListStructList; + +new DataGithubOrganizationIpAllowListIpAllowListStructList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubOrganizationIpAllowListIpAllowListStructOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubOrganizationIpAllowListIpAllowListStructOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_ip_allow_list.DataGithubOrganizationIpAllowListIpAllowListStructOutputReference; + +new DataGithubOrganizationIpAllowListIpAllowListStructOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| allowListValue | java.lang.String | *No description.* | +| createdAt | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| isActive | io.cdktn.cdktn.IResolvable | *No description.* | +| name | java.lang.String | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| internalValue | DataGithubOrganizationIpAllowListIpAllowListStruct | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `allowListValue`Required + +```java +public java.lang.String getAllowListValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `isActive`Required + +```java +public IResolvable getIsActive(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubOrganizationIpAllowListIpAllowListStruct getInternalValue(); +``` + +- *Type:* DataGithubOrganizationIpAllowListIpAllowListStruct + +--- + + + diff --git a/docs/dataGithubOrganizationRepositoryRole.csharp.md b/docs/dataGithubOrganizationRepositoryRole.csharp.md new file mode 100644 index 000000000..359eb8f0b --- /dev/null +++ b/docs/dataGithubOrganizationRepositoryRole.csharp.md @@ -0,0 +1,794 @@ +# `dataGithubOrganizationRepositoryRole` Submodule + +## Constructs + +### DataGithubOrganizationRepositoryRole + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_repository_role github_organization_repository_role}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRepositoryRole(Construct Scope, string Id, DataGithubOrganizationRepositoryRoleConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubOrganizationRepositoryRoleConfig | *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:* DataGithubOrganizationRepositoryRoleConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationRepositoryRole resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRepositoryRole.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRepositoryRole.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRepositoryRole.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRepositoryRole.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubOrganizationRepositoryRole resource upon running "cdktn 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 DataGithubOrganizationRepositoryRole to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubOrganizationRepositoryRole that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_repository_role#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubOrganizationRepositoryRole to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| BaseRole | string | *No description.* | +| Description | string | *No description.* | +| Name | string | *No description.* | +| Permissions | string[] | *No description.* | +| IdInput | string | *No description.* | +| RoleIdInput | double | *No description.* | +| Id | string | *No description.* | +| RoleId | double | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `BaseRole`Required + +```csharp +public string BaseRole { get; } +``` + +- *Type:* string + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Permissions`Required + +```csharp +public string[] Permissions { get; } +``` + +- *Type:* string[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RoleIdInput`Optional + +```csharp +public double RoleIdInput { get; } +``` + +- *Type:* double + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `RoleId`Required + +```csharp +public double RoleId { get; } +``` + +- *Type:* double + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubOrganizationRepositoryRoleConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRepositoryRoleConfig { + 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, + double RoleId, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| RoleId | double | The ID of the organization repository role. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_repository_role#id DataGithubOrganizationRepositoryRole#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `RoleId`Required + +```csharp +public double RoleId { get; set; } +``` + +- *Type:* double + +The ID of the organization repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_repository_role#role_id DataGithubOrganizationRepositoryRole#role_id} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_repository_role#id DataGithubOrganizationRepositoryRole#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. + +--- + + + diff --git a/docs/dataGithubOrganizationRepositoryRole.java.md b/docs/dataGithubOrganizationRepositoryRole.java.md new file mode 100644 index 000000000..474289f11 --- /dev/null +++ b/docs/dataGithubOrganizationRepositoryRole.java.md @@ -0,0 +1,869 @@ +# `dataGithubOrganizationRepositoryRole` Submodule + +## Constructs + +### DataGithubOrganizationRepositoryRole + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_repository_role github_organization_repository_role}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_repository_role.DataGithubOrganizationRepositoryRole; + +DataGithubOrganizationRepositoryRole.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .roleId(java.lang.Number) +// .id(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 | *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 | *No description.* | +| roleId | java.lang.Number | The ID of the organization repository role. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_repository_role#id DataGithubOrganizationRepositoryRole#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `roleId`Required + +- *Type:* java.lang.Number + +The ID of the organization repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_repository_role#role_id DataGithubOrganizationRepositoryRole#role_id} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_repository_role#id DataGithubOrganizationRepositoryRole#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationRepositoryRole resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_organization_repository_role.DataGithubOrganizationRepositoryRole; + +DataGithubOrganizationRepositoryRole.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` + +```java +import io.cdktn.providers.github.data_github_organization_repository_role.DataGithubOrganizationRepositoryRole; + +DataGithubOrganizationRepositoryRole.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_organization_repository_role.DataGithubOrganizationRepositoryRole; + +DataGithubOrganizationRepositoryRole.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_organization_repository_role.DataGithubOrganizationRepositoryRole; + +DataGithubOrganizationRepositoryRole.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubOrganizationRepositoryRole.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubOrganizationRepositoryRole 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 DataGithubOrganizationRepositoryRole to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubOrganizationRepositoryRole that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_repository_role#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 DataGithubOrganizationRepositoryRole 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| baseRole | java.lang.String | *No description.* | +| description | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| permissions | java.util.List | *No description.* | +| idInput | java.lang.String | *No description.* | +| roleIdInput | java.lang.Number | *No description.* | +| id | java.lang.String | *No description.* | +| roleId | java.lang.Number | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `baseRole`Required + +```java +public java.lang.String getBaseRole(); +``` + +- *Type:* java.lang.String + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `permissions`Required + +```java +public java.util.List getPermissions(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `roleIdInput`Optional + +```java +public java.lang.Number getRoleIdInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `roleId`Required + +```java +public java.lang.Number getRoleId(); +``` + +- *Type:* java.lang.Number + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubOrganizationRepositoryRoleConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_repository_role.DataGithubOrganizationRepositoryRoleConfig; + +DataGithubOrganizationRepositoryRoleConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .roleId(java.lang.Number) +// .id(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 | *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 | *No description.* | +| roleId | java.lang.Number | The ID of the organization repository role. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_repository_role#id DataGithubOrganizationRepositoryRole#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `roleId`Required + +```java +public java.lang.Number getRoleId(); +``` + +- *Type:* java.lang.Number + +The ID of the organization repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_repository_role#role_id DataGithubOrganizationRepositoryRole#role_id} + +--- + +##### `id`Optional + +```java +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_repository_role#id DataGithubOrganizationRepositoryRole#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. + +--- + + + diff --git a/docs/dataGithubOrganizationRepositoryRoles.csharp.md b/docs/dataGithubOrganizationRepositoryRoles.csharp.md new file mode 100644 index 000000000..a033f8924 --- /dev/null +++ b/docs/dataGithubOrganizationRepositoryRoles.csharp.md @@ -0,0 +1,1208 @@ +# `dataGithubOrganizationRepositoryRoles` Submodule + +## Constructs + +### DataGithubOrganizationRepositoryRoles + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_repository_roles github_organization_repository_roles}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRepositoryRoles(Construct Scope, string Id, DataGithubOrganizationRepositoryRolesConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubOrganizationRepositoryRolesConfig | *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`Optional + +- *Type:* DataGithubOrganizationRepositoryRolesConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationRepositoryRoles resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRepositoryRoles.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRepositoryRoles.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRepositoryRoles.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRepositoryRoles.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubOrganizationRepositoryRoles resource upon running "cdktn 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 DataGithubOrganizationRepositoryRoles to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubOrganizationRepositoryRoles that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_repository_roles#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubOrganizationRepositoryRoles to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Roles | DataGithubOrganizationRepositoryRolesRolesList | *No description.* | +| IdInput | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Roles`Required + +```csharp +public DataGithubOrganizationRepositoryRolesRolesList Roles { get; } +``` + +- *Type:* DataGithubOrganizationRepositoryRolesRolesList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubOrganizationRepositoryRolesConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRepositoryRolesConfig { + 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 Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_repository_roles#id DataGithubOrganizationRepositoryRoles#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_repository_roles#id DataGithubOrganizationRepositoryRoles#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. + +--- + +### DataGithubOrganizationRepositoryRolesRoles + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRepositoryRolesRoles { + +}; +``` + + +## Classes + +### DataGithubOrganizationRepositoryRolesRolesList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRepositoryRolesRolesList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubOrganizationRepositoryRolesRolesOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubOrganizationRepositoryRolesRolesOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRepositoryRolesRolesOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| BaseRole | string | *No description.* | +| Description | string | *No description.* | +| Name | string | *No description.* | +| Permissions | string[] | *No description.* | +| RoleId | double | *No description.* | +| InternalValue | DataGithubOrganizationRepositoryRolesRoles | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `BaseRole`Required + +```csharp +public string BaseRole { get; } +``` + +- *Type:* string + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Permissions`Required + +```csharp +public string[] Permissions { get; } +``` + +- *Type:* string[] + +--- + +##### `RoleId`Required + +```csharp +public double RoleId { get; } +``` + +- *Type:* double + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubOrganizationRepositoryRolesRoles InternalValue { get; } +``` + +- *Type:* DataGithubOrganizationRepositoryRolesRoles + +--- + + + diff --git a/docs/dataGithubOrganizationRepositoryRoles.java.md b/docs/dataGithubOrganizationRepositoryRoles.java.md new file mode 100644 index 000000000..9be59b00a --- /dev/null +++ b/docs/dataGithubOrganizationRepositoryRoles.java.md @@ -0,0 +1,1270 @@ +# `dataGithubOrganizationRepositoryRoles` Submodule + +## Constructs + +### DataGithubOrganizationRepositoryRoles + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_repository_roles github_organization_repository_roles}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_repository_roles.DataGithubOrganizationRepositoryRoles; + +DataGithubOrganizationRepositoryRoles.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_repository_roles#id DataGithubOrganizationRepositoryRoles#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_repository_roles#id DataGithubOrganizationRepositoryRoles#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationRepositoryRoles resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_organization_repository_roles.DataGithubOrganizationRepositoryRoles; + +DataGithubOrganizationRepositoryRoles.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` + +```java +import io.cdktn.providers.github.data_github_organization_repository_roles.DataGithubOrganizationRepositoryRoles; + +DataGithubOrganizationRepositoryRoles.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_organization_repository_roles.DataGithubOrganizationRepositoryRoles; + +DataGithubOrganizationRepositoryRoles.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_organization_repository_roles.DataGithubOrganizationRepositoryRoles; + +DataGithubOrganizationRepositoryRoles.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubOrganizationRepositoryRoles.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubOrganizationRepositoryRoles 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 DataGithubOrganizationRepositoryRoles to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubOrganizationRepositoryRoles that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_repository_roles#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 DataGithubOrganizationRepositoryRoles 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| roles | DataGithubOrganizationRepositoryRolesRolesList | *No description.* | +| idInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `roles`Required + +```java +public DataGithubOrganizationRepositoryRolesRolesList getRoles(); +``` + +- *Type:* DataGithubOrganizationRepositoryRolesRolesList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubOrganizationRepositoryRolesConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_repository_roles.DataGithubOrganizationRepositoryRolesConfig; + +DataGithubOrganizationRepositoryRolesConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_repository_roles#id DataGithubOrganizationRepositoryRoles#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Optional + +```java +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_repository_roles#id DataGithubOrganizationRepositoryRoles#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. + +--- + +### DataGithubOrganizationRepositoryRolesRoles + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_repository_roles.DataGithubOrganizationRepositoryRolesRoles; + +DataGithubOrganizationRepositoryRolesRoles.builder() + .build(); +``` + + +## Classes + +### DataGithubOrganizationRepositoryRolesRolesList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_repository_roles.DataGithubOrganizationRepositoryRolesRolesList; + +new DataGithubOrganizationRepositoryRolesRolesList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubOrganizationRepositoryRolesRolesOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubOrganizationRepositoryRolesRolesOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_repository_roles.DataGithubOrganizationRepositoryRolesRolesOutputReference; + +new DataGithubOrganizationRepositoryRolesRolesOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| baseRole | java.lang.String | *No description.* | +| description | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| permissions | java.util.List | *No description.* | +| roleId | java.lang.Number | *No description.* | +| internalValue | DataGithubOrganizationRepositoryRolesRoles | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `baseRole`Required + +```java +public java.lang.String getBaseRole(); +``` + +- *Type:* java.lang.String + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `permissions`Required + +```java +public java.util.List getPermissions(); +``` + +- *Type:* java.util.List + +--- + +##### `roleId`Required + +```java +public java.lang.Number getRoleId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `internalValue`Optional + +```java +public DataGithubOrganizationRepositoryRolesRoles getInternalValue(); +``` + +- *Type:* DataGithubOrganizationRepositoryRolesRoles + +--- + + + diff --git a/docs/dataGithubOrganizationRole.csharp.md b/docs/dataGithubOrganizationRole.csharp.md new file mode 100644 index 000000000..b59001457 --- /dev/null +++ b/docs/dataGithubOrganizationRole.csharp.md @@ -0,0 +1,805 @@ +# `dataGithubOrganizationRole` Submodule + +## Constructs + +### DataGithubOrganizationRole + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role github_organization_role}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRole(Construct Scope, string Id, DataGithubOrganizationRoleConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubOrganizationRoleConfig | *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:* DataGithubOrganizationRoleConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationRole resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRole.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRole.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRole.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRole.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubOrganizationRole resource upon running "cdktn 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 DataGithubOrganizationRole to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubOrganizationRole that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubOrganizationRole to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| BaseRole | string | *No description.* | +| Description | string | *No description.* | +| Name | string | *No description.* | +| Permissions | string[] | *No description.* | +| Source | string | *No description.* | +| IdInput | string | *No description.* | +| RoleIdInput | double | *No description.* | +| Id | string | *No description.* | +| RoleId | double | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `BaseRole`Required + +```csharp +public string BaseRole { get; } +``` + +- *Type:* string + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Permissions`Required + +```csharp +public string[] Permissions { get; } +``` + +- *Type:* string[] + +--- + +##### `Source`Required + +```csharp +public string Source { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RoleIdInput`Optional + +```csharp +public double RoleIdInput { get; } +``` + +- *Type:* double + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `RoleId`Required + +```csharp +public double RoleId { get; } +``` + +- *Type:* double + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubOrganizationRoleConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRoleConfig { + 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, + double RoleId, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| RoleId | double | The ID of the organization role. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role#id DataGithubOrganizationRole#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `RoleId`Required + +```csharp +public double RoleId { get; set; } +``` + +- *Type:* double + +The ID of the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role#role_id DataGithubOrganizationRole#role_id} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role#id DataGithubOrganizationRole#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. + +--- + + + diff --git a/docs/dataGithubOrganizationRole.java.md b/docs/dataGithubOrganizationRole.java.md new file mode 100644 index 000000000..953adaa00 --- /dev/null +++ b/docs/dataGithubOrganizationRole.java.md @@ -0,0 +1,880 @@ +# `dataGithubOrganizationRole` Submodule + +## Constructs + +### DataGithubOrganizationRole + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role github_organization_role}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_role.DataGithubOrganizationRole; + +DataGithubOrganizationRole.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .roleId(java.lang.Number) +// .id(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 | *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 | *No description.* | +| roleId | java.lang.Number | The ID of the organization role. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role#id DataGithubOrganizationRole#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `roleId`Required + +- *Type:* java.lang.Number + +The ID of the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role#role_id DataGithubOrganizationRole#role_id} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role#id DataGithubOrganizationRole#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationRole resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_organization_role.DataGithubOrganizationRole; + +DataGithubOrganizationRole.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` + +```java +import io.cdktn.providers.github.data_github_organization_role.DataGithubOrganizationRole; + +DataGithubOrganizationRole.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_organization_role.DataGithubOrganizationRole; + +DataGithubOrganizationRole.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_organization_role.DataGithubOrganizationRole; + +DataGithubOrganizationRole.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubOrganizationRole.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubOrganizationRole 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 DataGithubOrganizationRole to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubOrganizationRole that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role#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 DataGithubOrganizationRole 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| baseRole | java.lang.String | *No description.* | +| description | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| permissions | java.util.List | *No description.* | +| source | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| roleIdInput | java.lang.Number | *No description.* | +| id | java.lang.String | *No description.* | +| roleId | java.lang.Number | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `baseRole`Required + +```java +public java.lang.String getBaseRole(); +``` + +- *Type:* java.lang.String + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `permissions`Required + +```java +public java.util.List getPermissions(); +``` + +- *Type:* java.util.List + +--- + +##### `source`Required + +```java +public java.lang.String getSource(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `roleIdInput`Optional + +```java +public java.lang.Number getRoleIdInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `roleId`Required + +```java +public java.lang.Number getRoleId(); +``` + +- *Type:* java.lang.Number + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubOrganizationRoleConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_role.DataGithubOrganizationRoleConfig; + +DataGithubOrganizationRoleConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .roleId(java.lang.Number) +// .id(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 | *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 | *No description.* | +| roleId | java.lang.Number | The ID of the organization role. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role#id DataGithubOrganizationRole#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `roleId`Required + +```java +public java.lang.Number getRoleId(); +``` + +- *Type:* java.lang.Number + +The ID of the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role#role_id DataGithubOrganizationRole#role_id} + +--- + +##### `id`Optional + +```java +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_role#id DataGithubOrganizationRole#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. + +--- + + + diff --git a/docs/dataGithubOrganizationRoleTeams.csharp.md b/docs/dataGithubOrganizationRoleTeams.csharp.md new file mode 100644 index 000000000..645fc5a8f --- /dev/null +++ b/docs/dataGithubOrganizationRoleTeams.csharp.md @@ -0,0 +1,1235 @@ +# `dataGithubOrganizationRoleTeams` Submodule + +## Constructs + +### DataGithubOrganizationRoleTeams + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_teams github_organization_role_teams}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRoleTeams(Construct Scope, string Id, DataGithubOrganizationRoleTeamsConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubOrganizationRoleTeamsConfig | *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:* DataGithubOrganizationRoleTeamsConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationRoleTeams resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRoleTeams.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRoleTeams.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRoleTeams.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRoleTeams.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubOrganizationRoleTeams resource upon running "cdktn 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 DataGithubOrganizationRoleTeams to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubOrganizationRoleTeams that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_teams#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubOrganizationRoleTeams to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Teams | DataGithubOrganizationRoleTeamsTeamsList | *No description.* | +| IdInput | string | *No description.* | +| RoleIdInput | double | *No description.* | +| Id | string | *No description.* | +| RoleId | double | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Teams`Required + +```csharp +public DataGithubOrganizationRoleTeamsTeamsList Teams { get; } +``` + +- *Type:* DataGithubOrganizationRoleTeamsTeamsList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RoleIdInput`Optional + +```csharp +public double RoleIdInput { get; } +``` + +- *Type:* double + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `RoleId`Required + +```csharp +public double RoleId { get; } +``` + +- *Type:* double + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubOrganizationRoleTeamsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRoleTeamsConfig { + 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, + double RoleId, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| RoleId | double | The unique identifier of the organization role. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_teams#id DataGithubOrganizationRoleTeams#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `RoleId`Required + +```csharp +public double RoleId { get; set; } +``` + +- *Type:* double + +The unique identifier of the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_teams#role_id DataGithubOrganizationRoleTeams#role_id} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_teams#id DataGithubOrganizationRoleTeams#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. + +--- + +### DataGithubOrganizationRoleTeamsTeams + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRoleTeamsTeams { + +}; +``` + + +## Classes + +### DataGithubOrganizationRoleTeamsTeamsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRoleTeamsTeamsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubOrganizationRoleTeamsTeamsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubOrganizationRoleTeamsTeamsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRoleTeamsTeamsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Name | string | *No description.* | +| Permission | string | *No description.* | +| Slug | string | *No description.* | +| TeamId | double | *No description.* | +| InternalValue | DataGithubOrganizationRoleTeamsTeams | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Permission`Required + +```csharp +public string Permission { get; } +``` + +- *Type:* string + +--- + +##### `Slug`Required + +```csharp +public string Slug { get; } +``` + +- *Type:* string + +--- + +##### `TeamId`Required + +```csharp +public double TeamId { get; } +``` + +- *Type:* double + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubOrganizationRoleTeamsTeams InternalValue { get; } +``` + +- *Type:* DataGithubOrganizationRoleTeamsTeams + +--- + + + diff --git a/docs/dataGithubOrganizationRoleTeams.java.md b/docs/dataGithubOrganizationRoleTeams.java.md new file mode 100644 index 000000000..3f47adbfe --- /dev/null +++ b/docs/dataGithubOrganizationRoleTeams.java.md @@ -0,0 +1,1309 @@ +# `dataGithubOrganizationRoleTeams` Submodule + +## Constructs + +### DataGithubOrganizationRoleTeams + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_teams github_organization_role_teams}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_role_teams.DataGithubOrganizationRoleTeams; + +DataGithubOrganizationRoleTeams.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .roleId(java.lang.Number) +// .id(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 | *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 | *No description.* | +| roleId | java.lang.Number | The unique identifier of the organization role. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_teams#id DataGithubOrganizationRoleTeams#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `roleId`Required + +- *Type:* java.lang.Number + +The unique identifier of the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_teams#role_id DataGithubOrganizationRoleTeams#role_id} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_teams#id DataGithubOrganizationRoleTeams#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationRoleTeams resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_organization_role_teams.DataGithubOrganizationRoleTeams; + +DataGithubOrganizationRoleTeams.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` + +```java +import io.cdktn.providers.github.data_github_organization_role_teams.DataGithubOrganizationRoleTeams; + +DataGithubOrganizationRoleTeams.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_organization_role_teams.DataGithubOrganizationRoleTeams; + +DataGithubOrganizationRoleTeams.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_organization_role_teams.DataGithubOrganizationRoleTeams; + +DataGithubOrganizationRoleTeams.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubOrganizationRoleTeams.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubOrganizationRoleTeams 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 DataGithubOrganizationRoleTeams to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubOrganizationRoleTeams that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_teams#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 DataGithubOrganizationRoleTeams 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| teams | DataGithubOrganizationRoleTeamsTeamsList | *No description.* | +| idInput | java.lang.String | *No description.* | +| roleIdInput | java.lang.Number | *No description.* | +| id | java.lang.String | *No description.* | +| roleId | java.lang.Number | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `teams`Required + +```java +public DataGithubOrganizationRoleTeamsTeamsList getTeams(); +``` + +- *Type:* DataGithubOrganizationRoleTeamsTeamsList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `roleIdInput`Optional + +```java +public java.lang.Number getRoleIdInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `roleId`Required + +```java +public java.lang.Number getRoleId(); +``` + +- *Type:* java.lang.Number + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubOrganizationRoleTeamsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_role_teams.DataGithubOrganizationRoleTeamsConfig; + +DataGithubOrganizationRoleTeamsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .roleId(java.lang.Number) +// .id(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 | *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 | *No description.* | +| roleId | java.lang.Number | The unique identifier of the organization role. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_teams#id DataGithubOrganizationRoleTeams#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `roleId`Required + +```java +public java.lang.Number getRoleId(); +``` + +- *Type:* java.lang.Number + +The unique identifier of the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_teams#role_id DataGithubOrganizationRoleTeams#role_id} + +--- + +##### `id`Optional + +```java +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_role_teams#id DataGithubOrganizationRoleTeams#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. + +--- + +### DataGithubOrganizationRoleTeamsTeams + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_role_teams.DataGithubOrganizationRoleTeamsTeams; + +DataGithubOrganizationRoleTeamsTeams.builder() + .build(); +``` + + +## Classes + +### DataGithubOrganizationRoleTeamsTeamsList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_role_teams.DataGithubOrganizationRoleTeamsTeamsList; + +new DataGithubOrganizationRoleTeamsTeamsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubOrganizationRoleTeamsTeamsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubOrganizationRoleTeamsTeamsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_role_teams.DataGithubOrganizationRoleTeamsTeamsOutputReference; + +new DataGithubOrganizationRoleTeamsTeamsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| permission | java.lang.String | *No description.* | +| slug | java.lang.String | *No description.* | +| teamId | java.lang.Number | *No description.* | +| internalValue | DataGithubOrganizationRoleTeamsTeams | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `permission`Required + +```java +public java.lang.String getPermission(); +``` + +- *Type:* java.lang.String + +--- + +##### `slug`Required + +```java +public java.lang.String getSlug(); +``` + +- *Type:* java.lang.String + +--- + +##### `teamId`Required + +```java +public java.lang.Number getTeamId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `internalValue`Optional + +```java +public DataGithubOrganizationRoleTeamsTeams getInternalValue(); +``` + +- *Type:* DataGithubOrganizationRoleTeamsTeams + +--- + + + diff --git a/docs/dataGithubOrganizationRoleUsers.csharp.md b/docs/dataGithubOrganizationRoleUsers.csharp.md new file mode 100644 index 000000000..5f0f4965b --- /dev/null +++ b/docs/dataGithubOrganizationRoleUsers.csharp.md @@ -0,0 +1,1213 @@ +# `dataGithubOrganizationRoleUsers` Submodule + +## Constructs + +### DataGithubOrganizationRoleUsers + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_users github_organization_role_users}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRoleUsers(Construct Scope, string Id, DataGithubOrganizationRoleUsersConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubOrganizationRoleUsersConfig | *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:* DataGithubOrganizationRoleUsersConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationRoleUsers resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRoleUsers.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRoleUsers.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRoleUsers.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRoleUsers.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubOrganizationRoleUsers resource upon running "cdktn 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 DataGithubOrganizationRoleUsers to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubOrganizationRoleUsers that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_users#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubOrganizationRoleUsers to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Users | DataGithubOrganizationRoleUsersUsersList | *No description.* | +| IdInput | string | *No description.* | +| RoleIdInput | double | *No description.* | +| Id | string | *No description.* | +| RoleId | double | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Users`Required + +```csharp +public DataGithubOrganizationRoleUsersUsersList Users { get; } +``` + +- *Type:* DataGithubOrganizationRoleUsersUsersList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RoleIdInput`Optional + +```csharp +public double RoleIdInput { get; } +``` + +- *Type:* double + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `RoleId`Required + +```csharp +public double RoleId { get; } +``` + +- *Type:* double + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubOrganizationRoleUsersConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRoleUsersConfig { + 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, + double RoleId, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| RoleId | double | The ID of the organization role. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_users#id DataGithubOrganizationRoleUsers#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `RoleId`Required + +```csharp +public double RoleId { get; set; } +``` + +- *Type:* double + +The ID of the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_users#role_id DataGithubOrganizationRoleUsers#role_id} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_users#id DataGithubOrganizationRoleUsers#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. + +--- + +### DataGithubOrganizationRoleUsersUsers + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRoleUsersUsers { + +}; +``` + + +## Classes + +### DataGithubOrganizationRoleUsersUsersList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRoleUsersUsersList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubOrganizationRoleUsersUsersOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubOrganizationRoleUsersUsersOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRoleUsersUsersOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Login | string | *No description.* | +| UserId | double | *No description.* | +| InternalValue | DataGithubOrganizationRoleUsersUsers | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Login`Required + +```csharp +public string Login { get; } +``` + +- *Type:* string + +--- + +##### `UserId`Required + +```csharp +public double UserId { get; } +``` + +- *Type:* double + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubOrganizationRoleUsersUsers InternalValue { get; } +``` + +- *Type:* DataGithubOrganizationRoleUsersUsers + +--- + + + diff --git a/docs/dataGithubOrganizationRoleUsers.java.md b/docs/dataGithubOrganizationRoleUsers.java.md new file mode 100644 index 000000000..4a6ce3fa3 --- /dev/null +++ b/docs/dataGithubOrganizationRoleUsers.java.md @@ -0,0 +1,1287 @@ +# `dataGithubOrganizationRoleUsers` Submodule + +## Constructs + +### DataGithubOrganizationRoleUsers + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_users github_organization_role_users}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_role_users.DataGithubOrganizationRoleUsers; + +DataGithubOrganizationRoleUsers.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .roleId(java.lang.Number) +// .id(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 | *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 | *No description.* | +| roleId | java.lang.Number | The ID of the organization role. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_users#id DataGithubOrganizationRoleUsers#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `roleId`Required + +- *Type:* java.lang.Number + +The ID of the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_users#role_id DataGithubOrganizationRoleUsers#role_id} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_users#id DataGithubOrganizationRoleUsers#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationRoleUsers resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_organization_role_users.DataGithubOrganizationRoleUsers; + +DataGithubOrganizationRoleUsers.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` + +```java +import io.cdktn.providers.github.data_github_organization_role_users.DataGithubOrganizationRoleUsers; + +DataGithubOrganizationRoleUsers.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_organization_role_users.DataGithubOrganizationRoleUsers; + +DataGithubOrganizationRoleUsers.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_organization_role_users.DataGithubOrganizationRoleUsers; + +DataGithubOrganizationRoleUsers.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubOrganizationRoleUsers.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubOrganizationRoleUsers 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 DataGithubOrganizationRoleUsers to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubOrganizationRoleUsers that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_users#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 DataGithubOrganizationRoleUsers 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| users | DataGithubOrganizationRoleUsersUsersList | *No description.* | +| idInput | java.lang.String | *No description.* | +| roleIdInput | java.lang.Number | *No description.* | +| id | java.lang.String | *No description.* | +| roleId | java.lang.Number | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `users`Required + +```java +public DataGithubOrganizationRoleUsersUsersList getUsers(); +``` + +- *Type:* DataGithubOrganizationRoleUsersUsersList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `roleIdInput`Optional + +```java +public java.lang.Number getRoleIdInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `roleId`Required + +```java +public java.lang.Number getRoleId(); +``` + +- *Type:* java.lang.Number + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubOrganizationRoleUsersConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_role_users.DataGithubOrganizationRoleUsersConfig; + +DataGithubOrganizationRoleUsersConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .roleId(java.lang.Number) +// .id(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 | *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 | *No description.* | +| roleId | java.lang.Number | The ID of the organization role. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_users#id DataGithubOrganizationRoleUsers#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `roleId`Required + +```java +public java.lang.Number getRoleId(); +``` + +- *Type:* java.lang.Number + +The ID of the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_role_users#role_id DataGithubOrganizationRoleUsers#role_id} + +--- + +##### `id`Optional + +```java +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_role_users#id DataGithubOrganizationRoleUsers#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. + +--- + +### DataGithubOrganizationRoleUsersUsers + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_role_users.DataGithubOrganizationRoleUsersUsers; + +DataGithubOrganizationRoleUsersUsers.builder() + .build(); +``` + + +## Classes + +### DataGithubOrganizationRoleUsersUsersList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_role_users.DataGithubOrganizationRoleUsersUsersList; + +new DataGithubOrganizationRoleUsersUsersList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubOrganizationRoleUsersUsersOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubOrganizationRoleUsersUsersOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_role_users.DataGithubOrganizationRoleUsersUsersOutputReference; + +new DataGithubOrganizationRoleUsersUsersOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| login | java.lang.String | *No description.* | +| userId | java.lang.Number | *No description.* | +| internalValue | DataGithubOrganizationRoleUsersUsers | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `login`Required + +```java +public java.lang.String getLogin(); +``` + +- *Type:* java.lang.String + +--- + +##### `userId`Required + +```java +public java.lang.Number getUserId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `internalValue`Optional + +```java +public DataGithubOrganizationRoleUsersUsers getInternalValue(); +``` + +- *Type:* DataGithubOrganizationRoleUsersUsers + +--- + + + diff --git a/docs/dataGithubOrganizationRoles.csharp.md b/docs/dataGithubOrganizationRoles.csharp.md new file mode 100644 index 000000000..67516e9af --- /dev/null +++ b/docs/dataGithubOrganizationRoles.csharp.md @@ -0,0 +1,1219 @@ +# `dataGithubOrganizationRoles` Submodule + +## Constructs + +### DataGithubOrganizationRoles + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_roles github_organization_roles}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRoles(Construct Scope, string Id, DataGithubOrganizationRolesConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubOrganizationRolesConfig | *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`Optional + +- *Type:* DataGithubOrganizationRolesConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationRoles resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRoles.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRoles.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRoles.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationRoles.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubOrganizationRoles resource upon running "cdktn 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 DataGithubOrganizationRoles to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubOrganizationRoles that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_roles#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubOrganizationRoles to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Roles | DataGithubOrganizationRolesRolesList | *No description.* | +| IdInput | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Roles`Required + +```csharp +public DataGithubOrganizationRolesRolesList Roles { get; } +``` + +- *Type:* DataGithubOrganizationRolesRolesList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubOrganizationRolesConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRolesConfig { + 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 Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_roles#id DataGithubOrganizationRoles#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_roles#id DataGithubOrganizationRoles#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. + +--- + +### DataGithubOrganizationRolesRoles + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRolesRoles { + +}; +``` + + +## Classes + +### DataGithubOrganizationRolesRolesList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRolesRolesList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubOrganizationRolesRolesOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubOrganizationRolesRolesOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationRolesRolesOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| BaseRole | string | *No description.* | +| Description | string | *No description.* | +| Name | string | *No description.* | +| Permissions | string[] | *No description.* | +| RoleId | double | *No description.* | +| Source | string | *No description.* | +| InternalValue | DataGithubOrganizationRolesRoles | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `BaseRole`Required + +```csharp +public string BaseRole { get; } +``` + +- *Type:* string + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Permissions`Required + +```csharp +public string[] Permissions { get; } +``` + +- *Type:* string[] + +--- + +##### `RoleId`Required + +```csharp +public double RoleId { get; } +``` + +- *Type:* double + +--- + +##### `Source`Required + +```csharp +public string Source { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubOrganizationRolesRoles InternalValue { get; } +``` + +- *Type:* DataGithubOrganizationRolesRoles + +--- + + + diff --git a/docs/dataGithubOrganizationRoles.java.md b/docs/dataGithubOrganizationRoles.java.md new file mode 100644 index 000000000..14ca50d49 --- /dev/null +++ b/docs/dataGithubOrganizationRoles.java.md @@ -0,0 +1,1281 @@ +# `dataGithubOrganizationRoles` Submodule + +## Constructs + +### DataGithubOrganizationRoles + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_roles github_organization_roles}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_roles.DataGithubOrganizationRoles; + +DataGithubOrganizationRoles.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_roles#id DataGithubOrganizationRoles#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_roles#id DataGithubOrganizationRoles#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationRoles resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_organization_roles.DataGithubOrganizationRoles; + +DataGithubOrganizationRoles.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` + +```java +import io.cdktn.providers.github.data_github_organization_roles.DataGithubOrganizationRoles; + +DataGithubOrganizationRoles.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_organization_roles.DataGithubOrganizationRoles; + +DataGithubOrganizationRoles.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_organization_roles.DataGithubOrganizationRoles; + +DataGithubOrganizationRoles.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubOrganizationRoles.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubOrganizationRoles 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 DataGithubOrganizationRoles to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubOrganizationRoles that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_roles#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 DataGithubOrganizationRoles 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| roles | DataGithubOrganizationRolesRolesList | *No description.* | +| idInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `roles`Required + +```java +public DataGithubOrganizationRolesRolesList getRoles(); +``` + +- *Type:* DataGithubOrganizationRolesRolesList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubOrganizationRolesConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_roles.DataGithubOrganizationRolesConfig; + +DataGithubOrganizationRolesConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_roles#id DataGithubOrganizationRoles#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Optional + +```java +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_roles#id DataGithubOrganizationRoles#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. + +--- + +### DataGithubOrganizationRolesRoles + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_roles.DataGithubOrganizationRolesRoles; + +DataGithubOrganizationRolesRoles.builder() + .build(); +``` + + +## Classes + +### DataGithubOrganizationRolesRolesList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_roles.DataGithubOrganizationRolesRolesList; + +new DataGithubOrganizationRolesRolesList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubOrganizationRolesRolesOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubOrganizationRolesRolesOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_roles.DataGithubOrganizationRolesRolesOutputReference; + +new DataGithubOrganizationRolesRolesOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| baseRole | java.lang.String | *No description.* | +| description | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| permissions | java.util.List | *No description.* | +| roleId | java.lang.Number | *No description.* | +| source | java.lang.String | *No description.* | +| internalValue | DataGithubOrganizationRolesRoles | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `baseRole`Required + +```java +public java.lang.String getBaseRole(); +``` + +- *Type:* java.lang.String + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `permissions`Required + +```java +public java.util.List getPermissions(); +``` + +- *Type:* java.util.List + +--- + +##### `roleId`Required + +```java +public java.lang.Number getRoleId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `source`Required + +```java +public java.lang.String getSource(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubOrganizationRolesRoles getInternalValue(); +``` + +- *Type:* DataGithubOrganizationRolesRoles + +--- + + + diff --git a/docs/dataGithubOrganizationSecurityManagers.csharp.md b/docs/dataGithubOrganizationSecurityManagers.csharp.md new file mode 100644 index 000000000..921da4849 --- /dev/null +++ b/docs/dataGithubOrganizationSecurityManagers.csharp.md @@ -0,0 +1,1197 @@ +# `dataGithubOrganizationSecurityManagers` Submodule + +## Constructs + +### DataGithubOrganizationSecurityManagers + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_security_managers github_organization_security_managers}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationSecurityManagers(Construct Scope, string Id, DataGithubOrganizationSecurityManagersConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubOrganizationSecurityManagersConfig | *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`Optional + +- *Type:* DataGithubOrganizationSecurityManagersConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationSecurityManagers resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationSecurityManagers.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationSecurityManagers.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationSecurityManagers.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationSecurityManagers.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubOrganizationSecurityManagers resource upon running "cdktn 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 DataGithubOrganizationSecurityManagers to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubOrganizationSecurityManagers that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_security_managers#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubOrganizationSecurityManagers to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Teams | DataGithubOrganizationSecurityManagersTeamsList | *No description.* | +| IdInput | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Teams`Required + +```csharp +public DataGithubOrganizationSecurityManagersTeamsList Teams { get; } +``` + +- *Type:* DataGithubOrganizationSecurityManagersTeamsList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubOrganizationSecurityManagersConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationSecurityManagersConfig { + 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 Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_security_managers#id DataGithubOrganizationSecurityManagers#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_security_managers#id DataGithubOrganizationSecurityManagers#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. + +--- + +### DataGithubOrganizationSecurityManagersTeams + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationSecurityManagersTeams { + +}; +``` + + +## Classes + +### DataGithubOrganizationSecurityManagersTeamsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationSecurityManagersTeamsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubOrganizationSecurityManagersTeamsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubOrganizationSecurityManagersTeamsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationSecurityManagersTeamsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Id | double | *No description.* | +| Name | string | *No description.* | +| Permission | string | *No description.* | +| Slug | string | *No description.* | +| InternalValue | DataGithubOrganizationSecurityManagersTeams | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public double Id { get; } +``` + +- *Type:* double + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Permission`Required + +```csharp +public string Permission { get; } +``` + +- *Type:* string + +--- + +##### `Slug`Required + +```csharp +public string Slug { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubOrganizationSecurityManagersTeams InternalValue { get; } +``` + +- *Type:* DataGithubOrganizationSecurityManagersTeams + +--- + + + diff --git a/docs/dataGithubOrganizationSecurityManagers.java.md b/docs/dataGithubOrganizationSecurityManagers.java.md new file mode 100644 index 000000000..e478c68aa --- /dev/null +++ b/docs/dataGithubOrganizationSecurityManagers.java.md @@ -0,0 +1,1259 @@ +# `dataGithubOrganizationSecurityManagers` Submodule + +## Constructs + +### DataGithubOrganizationSecurityManagers + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_security_managers github_organization_security_managers}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_security_managers.DataGithubOrganizationSecurityManagers; + +DataGithubOrganizationSecurityManagers.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_security_managers#id DataGithubOrganizationSecurityManagers#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_security_managers#id DataGithubOrganizationSecurityManagers#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationSecurityManagers resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_organization_security_managers.DataGithubOrganizationSecurityManagers; + +DataGithubOrganizationSecurityManagers.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` + +```java +import io.cdktn.providers.github.data_github_organization_security_managers.DataGithubOrganizationSecurityManagers; + +DataGithubOrganizationSecurityManagers.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_organization_security_managers.DataGithubOrganizationSecurityManagers; + +DataGithubOrganizationSecurityManagers.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_organization_security_managers.DataGithubOrganizationSecurityManagers; + +DataGithubOrganizationSecurityManagers.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubOrganizationSecurityManagers.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubOrganizationSecurityManagers 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 DataGithubOrganizationSecurityManagers to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubOrganizationSecurityManagers that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_security_managers#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 DataGithubOrganizationSecurityManagers 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| teams | DataGithubOrganizationSecurityManagersTeamsList | *No description.* | +| idInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `teams`Required + +```java +public DataGithubOrganizationSecurityManagersTeamsList getTeams(); +``` + +- *Type:* DataGithubOrganizationSecurityManagersTeamsList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubOrganizationSecurityManagersConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_security_managers.DataGithubOrganizationSecurityManagersConfig; + +DataGithubOrganizationSecurityManagersConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_security_managers#id DataGithubOrganizationSecurityManagers#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Optional + +```java +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_security_managers#id DataGithubOrganizationSecurityManagers#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. + +--- + +### DataGithubOrganizationSecurityManagersTeams + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_security_managers.DataGithubOrganizationSecurityManagersTeams; + +DataGithubOrganizationSecurityManagersTeams.builder() + .build(); +``` + + +## Classes + +### DataGithubOrganizationSecurityManagersTeamsList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_security_managers.DataGithubOrganizationSecurityManagersTeamsList; + +new DataGithubOrganizationSecurityManagersTeamsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubOrganizationSecurityManagersTeamsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubOrganizationSecurityManagersTeamsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_security_managers.DataGithubOrganizationSecurityManagersTeamsOutputReference; + +new DataGithubOrganizationSecurityManagersTeamsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| id | java.lang.Number | *No description.* | +| name | java.lang.String | *No description.* | +| permission | java.lang.String | *No description.* | +| slug | java.lang.String | *No description.* | +| internalValue | DataGithubOrganizationSecurityManagersTeams | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.Number getId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `permission`Required + +```java +public java.lang.String getPermission(); +``` + +- *Type:* java.lang.String + +--- + +##### `slug`Required + +```java +public java.lang.String getSlug(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubOrganizationSecurityManagersTeams getInternalValue(); +``` + +- *Type:* DataGithubOrganizationSecurityManagersTeams + +--- + + + diff --git a/docs/dataGithubOrganizationTeamSyncGroups.csharp.md b/docs/dataGithubOrganizationTeamSyncGroups.csharp.md new file mode 100644 index 000000000..0d17f2d2f --- /dev/null +++ b/docs/dataGithubOrganizationTeamSyncGroups.csharp.md @@ -0,0 +1,1186 @@ +# `dataGithubOrganizationTeamSyncGroups` Submodule + +## Constructs + +### DataGithubOrganizationTeamSyncGroups + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_team_sync_groups github_organization_team_sync_groups}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationTeamSyncGroups(Construct Scope, string Id, DataGithubOrganizationTeamSyncGroupsConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubOrganizationTeamSyncGroupsConfig | *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`Optional + +- *Type:* DataGithubOrganizationTeamSyncGroupsConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationTeamSyncGroups resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationTeamSyncGroups.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationTeamSyncGroups.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationTeamSyncGroups.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationTeamSyncGroups.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubOrganizationTeamSyncGroups resource upon running "cdktn 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 DataGithubOrganizationTeamSyncGroups to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubOrganizationTeamSyncGroups that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_team_sync_groups#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubOrganizationTeamSyncGroups to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Groups | DataGithubOrganizationTeamSyncGroupsGroupsList | *No description.* | +| IdInput | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Groups`Required + +```csharp +public DataGithubOrganizationTeamSyncGroupsGroupsList Groups { get; } +``` + +- *Type:* DataGithubOrganizationTeamSyncGroupsGroupsList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubOrganizationTeamSyncGroupsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationTeamSyncGroupsConfig { + 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 Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_team_sync_groups#id DataGithubOrganizationTeamSyncGroups#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_team_sync_groups#id DataGithubOrganizationTeamSyncGroups#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. + +--- + +### DataGithubOrganizationTeamSyncGroupsGroups + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationTeamSyncGroupsGroups { + +}; +``` + + +## Classes + +### DataGithubOrganizationTeamSyncGroupsGroupsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationTeamSyncGroupsGroupsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubOrganizationTeamSyncGroupsGroupsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubOrganizationTeamSyncGroupsGroupsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationTeamSyncGroupsGroupsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| GroupDescription | string | *No description.* | +| GroupId | string | *No description.* | +| GroupName | string | *No description.* | +| InternalValue | DataGithubOrganizationTeamSyncGroupsGroups | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `GroupDescription`Required + +```csharp +public string GroupDescription { get; } +``` + +- *Type:* string + +--- + +##### `GroupId`Required + +```csharp +public string GroupId { get; } +``` + +- *Type:* string + +--- + +##### `GroupName`Required + +```csharp +public string GroupName { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubOrganizationTeamSyncGroupsGroups InternalValue { get; } +``` + +- *Type:* DataGithubOrganizationTeamSyncGroupsGroups + +--- + + + diff --git a/docs/dataGithubOrganizationTeamSyncGroups.java.md b/docs/dataGithubOrganizationTeamSyncGroups.java.md new file mode 100644 index 000000000..cccfa62a2 --- /dev/null +++ b/docs/dataGithubOrganizationTeamSyncGroups.java.md @@ -0,0 +1,1248 @@ +# `dataGithubOrganizationTeamSyncGroups` Submodule + +## Constructs + +### DataGithubOrganizationTeamSyncGroups + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_team_sync_groups github_organization_team_sync_groups}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_team_sync_groups.DataGithubOrganizationTeamSyncGroups; + +DataGithubOrganizationTeamSyncGroups.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_team_sync_groups#id DataGithubOrganizationTeamSyncGroups#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_team_sync_groups#id DataGithubOrganizationTeamSyncGroups#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationTeamSyncGroups resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_organization_team_sync_groups.DataGithubOrganizationTeamSyncGroups; + +DataGithubOrganizationTeamSyncGroups.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` + +```java +import io.cdktn.providers.github.data_github_organization_team_sync_groups.DataGithubOrganizationTeamSyncGroups; + +DataGithubOrganizationTeamSyncGroups.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_organization_team_sync_groups.DataGithubOrganizationTeamSyncGroups; + +DataGithubOrganizationTeamSyncGroups.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_organization_team_sync_groups.DataGithubOrganizationTeamSyncGroups; + +DataGithubOrganizationTeamSyncGroups.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubOrganizationTeamSyncGroups.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubOrganizationTeamSyncGroups 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 DataGithubOrganizationTeamSyncGroups to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubOrganizationTeamSyncGroups that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_team_sync_groups#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 DataGithubOrganizationTeamSyncGroups 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| groups | DataGithubOrganizationTeamSyncGroupsGroupsList | *No description.* | +| idInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `groups`Required + +```java +public DataGithubOrganizationTeamSyncGroupsGroupsList getGroups(); +``` + +- *Type:* DataGithubOrganizationTeamSyncGroupsGroupsList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubOrganizationTeamSyncGroupsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_team_sync_groups.DataGithubOrganizationTeamSyncGroupsConfig; + +DataGithubOrganizationTeamSyncGroupsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_team_sync_groups#id DataGithubOrganizationTeamSyncGroups#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Optional + +```java +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_team_sync_groups#id DataGithubOrganizationTeamSyncGroups#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. + +--- + +### DataGithubOrganizationTeamSyncGroupsGroups + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_team_sync_groups.DataGithubOrganizationTeamSyncGroupsGroups; + +DataGithubOrganizationTeamSyncGroupsGroups.builder() + .build(); +``` + + +## Classes + +### DataGithubOrganizationTeamSyncGroupsGroupsList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_team_sync_groups.DataGithubOrganizationTeamSyncGroupsGroupsList; + +new DataGithubOrganizationTeamSyncGroupsGroupsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubOrganizationTeamSyncGroupsGroupsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubOrganizationTeamSyncGroupsGroupsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_team_sync_groups.DataGithubOrganizationTeamSyncGroupsGroupsOutputReference; + +new DataGithubOrganizationTeamSyncGroupsGroupsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| groupDescription | java.lang.String | *No description.* | +| groupId | java.lang.String | *No description.* | +| groupName | java.lang.String | *No description.* | +| internalValue | DataGithubOrganizationTeamSyncGroupsGroups | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `groupDescription`Required + +```java +public java.lang.String getGroupDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `groupId`Required + +```java +public java.lang.String getGroupId(); +``` + +- *Type:* java.lang.String + +--- + +##### `groupName`Required + +```java +public java.lang.String getGroupName(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubOrganizationTeamSyncGroupsGroups getInternalValue(); +``` + +- *Type:* DataGithubOrganizationTeamSyncGroupsGroups + +--- + + + diff --git a/docs/dataGithubOrganizationTeams.csharp.md b/docs/dataGithubOrganizationTeams.csharp.md new file mode 100644 index 000000000..208f90508 --- /dev/null +++ b/docs/dataGithubOrganizationTeams.csharp.md @@ -0,0 +1,1403 @@ +# `dataGithubOrganizationTeams` Submodule + +## Constructs + +### DataGithubOrganizationTeams + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_teams github_organization_teams}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationTeams(Construct Scope, string Id, DataGithubOrganizationTeamsConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubOrganizationTeamsConfig | *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`Optional + +- *Type:* DataGithubOrganizationTeamsConfig + +--- + +#### 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.* | +| ResetResultsPerPage | *No description.* | +| ResetRootTeamsOnly | *No description.* | +| ResetSummaryOnly | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetResultsPerPage` + +```csharp +private void ResetResultsPerPage() +``` + +##### `ResetRootTeamsOnly` + +```csharp +private void ResetRootTeamsOnly() +``` + +##### `ResetSummaryOnly` + +```csharp +private void ResetSummaryOnly() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationTeams resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationTeams.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationTeams.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationTeams.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationTeams.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubOrganizationTeams resource upon running "cdktn 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 DataGithubOrganizationTeams to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubOrganizationTeams that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_teams#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubOrganizationTeams to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Teams | DataGithubOrganizationTeamsTeamsList | *No description.* | +| IdInput | string | *No description.* | +| ResultsPerPageInput | double | *No description.* | +| RootTeamsOnlyInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| SummaryOnlyInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| Id | string | *No description.* | +| ResultsPerPage | double | *No description.* | +| RootTeamsOnly | bool\|Io.Cdktn.IResolvable | *No description.* | +| SummaryOnly | bool\|Io.Cdktn.IResolvable | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Teams`Required + +```csharp +public DataGithubOrganizationTeamsTeamsList Teams { get; } +``` + +- *Type:* DataGithubOrganizationTeamsTeamsList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `ResultsPerPageInput`Optional + +```csharp +public double ResultsPerPageInput { get; } +``` + +- *Type:* double + +--- + +##### `RootTeamsOnlyInput`Optional + +```csharp +public bool|IResolvable RootTeamsOnlyInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `SummaryOnlyInput`Optional + +```csharp +public bool|IResolvable SummaryOnlyInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `ResultsPerPage`Required + +```csharp +public double ResultsPerPage { get; } +``` + +- *Type:* double + +--- + +##### `RootTeamsOnly`Required + +```csharp +public bool|IResolvable RootTeamsOnly { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `SummaryOnly`Required + +```csharp +public bool|IResolvable SummaryOnly { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubOrganizationTeamsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationTeamsConfig { + 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 Id = null, + double ResultsPerPage = null, + bool|IResolvable RootTeamsOnly = null, + bool|IResolvable SummaryOnly = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_teams#id DataGithubOrganizationTeams#id}. | +| ResultsPerPage | double | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_teams#results_per_page DataGithubOrganizationTeams#results_per_page}. | +| RootTeamsOnly | bool\|Io.Cdktn.IResolvable | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_teams#root_teams_only DataGithubOrganizationTeams#root_teams_only}. | +| SummaryOnly | bool\|Io.Cdktn.IResolvable | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_teams#summary_only DataGithubOrganizationTeams#summary_only}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_teams#id DataGithubOrganizationTeams#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. + +--- + +##### `ResultsPerPage`Optional + +```csharp +public double ResultsPerPage { get; set; } +``` + +- *Type:* double + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_teams#results_per_page DataGithubOrganizationTeams#results_per_page}. + +--- + +##### `RootTeamsOnly`Optional + +```csharp +public bool|IResolvable RootTeamsOnly { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_teams#root_teams_only DataGithubOrganizationTeams#root_teams_only}. + +--- + +##### `SummaryOnly`Optional + +```csharp +public bool|IResolvable SummaryOnly { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_teams#summary_only DataGithubOrganizationTeams#summary_only}. + +--- + +### DataGithubOrganizationTeamsTeams + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationTeamsTeams { + +}; +``` + + +## Classes + +### DataGithubOrganizationTeamsTeamsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationTeamsTeamsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubOrganizationTeamsTeamsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubOrganizationTeamsTeamsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationTeamsTeamsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Description | string | *No description.* | +| Id | double | *No description.* | +| Members | string[] | *No description.* | +| Name | string | *No description.* | +| NodeId | string | *No description.* | +| Parent | Io.Cdktn.StringMap | *No description.* | +| ParentTeamId | string | *No description.* | +| ParentTeamSlug | string | *No description.* | +| Privacy | string | *No description.* | +| Repositories | string[] | *No description.* | +| Slug | string | *No description.* | +| InternalValue | DataGithubOrganizationTeamsTeams | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public double Id { get; } +``` + +- *Type:* double + +--- + +##### `Members`Required + +```csharp +public string[] Members { get; } +``` + +- *Type:* string[] + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `NodeId`Required + +```csharp +public string NodeId { get; } +``` + +- *Type:* string + +--- + +##### `Parent`Required + +```csharp +public StringMap Parent { get; } +``` + +- *Type:* Io.Cdktn.StringMap + +--- + +##### `ParentTeamId`Required + +```csharp +public string ParentTeamId { get; } +``` + +- *Type:* string + +--- + +##### `ParentTeamSlug`Required + +```csharp +public string ParentTeamSlug { get; } +``` + +- *Type:* string + +--- + +##### `Privacy`Required + +```csharp +public string Privacy { get; } +``` + +- *Type:* string + +--- + +##### `Repositories`Required + +```csharp +public string[] Repositories { get; } +``` + +- *Type:* string[] + +--- + +##### `Slug`Required + +```csharp +public string Slug { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubOrganizationTeamsTeams InternalValue { get; } +``` + +- *Type:* DataGithubOrganizationTeamsTeams + +--- + + + diff --git a/docs/dataGithubOrganizationTeams.java.md b/docs/dataGithubOrganizationTeams.java.md new file mode 100644 index 000000000..89e609281 --- /dev/null +++ b/docs/dataGithubOrganizationTeams.java.md @@ -0,0 +1,1495 @@ +# `dataGithubOrganizationTeams` Submodule + +## Constructs + +### DataGithubOrganizationTeams + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_teams github_organization_teams}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_teams.DataGithubOrganizationTeams; + +DataGithubOrganizationTeams.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(java.lang.String) +// .resultsPerPage(java.lang.Number) +// .rootTeamsOnly(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_teams#id DataGithubOrganizationTeams#id}. | +| resultsPerPage | java.lang.Number | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_teams#results_per_page DataGithubOrganizationTeams#results_per_page}. | +| rootTeamsOnly | 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_teams#root_teams_only DataGithubOrganizationTeams#root_teams_only}. | +| 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_teams#summary_only DataGithubOrganizationTeams#summary_only}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_teams#id DataGithubOrganizationTeams#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. + +--- + +##### `resultsPerPage`Optional + +- *Type:* java.lang.Number + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_teams#results_per_page DataGithubOrganizationTeams#results_per_page}. + +--- + +##### `rootTeamsOnly`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/organization_teams#root_teams_only DataGithubOrganizationTeams#root_teams_only}. + +--- + +##### `summaryOnly`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/organization_teams#summary_only DataGithubOrganizationTeams#summary_only}. + +--- + +#### 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.* | +| resetResultsPerPage | *No description.* | +| resetRootTeamsOnly | *No description.* | +| resetSummaryOnly | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetResultsPerPage` + +```java +public void resetResultsPerPage() +``` + +##### `resetRootTeamsOnly` + +```java +public void resetRootTeamsOnly() +``` + +##### `resetSummaryOnly` + +```java +public void resetSummaryOnly() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationTeams resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_organization_teams.DataGithubOrganizationTeams; + +DataGithubOrganizationTeams.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` + +```java +import io.cdktn.providers.github.data_github_organization_teams.DataGithubOrganizationTeams; + +DataGithubOrganizationTeams.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_organization_teams.DataGithubOrganizationTeams; + +DataGithubOrganizationTeams.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_organization_teams.DataGithubOrganizationTeams; + +DataGithubOrganizationTeams.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubOrganizationTeams.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubOrganizationTeams 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 DataGithubOrganizationTeams to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubOrganizationTeams that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_teams#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 DataGithubOrganizationTeams 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| teams | DataGithubOrganizationTeamsTeamsList | *No description.* | +| idInput | java.lang.String | *No description.* | +| resultsPerPageInput | java.lang.Number | *No description.* | +| rootTeamsOnlyInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| summaryOnlyInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| id | java.lang.String | *No description.* | +| resultsPerPage | java.lang.Number | *No description.* | +| rootTeamsOnly | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| summaryOnly | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `teams`Required + +```java +public DataGithubOrganizationTeamsTeamsList getTeams(); +``` + +- *Type:* DataGithubOrganizationTeamsTeamsList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `resultsPerPageInput`Optional + +```java +public java.lang.Number getResultsPerPageInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `rootTeamsOnlyInput`Optional + +```java +public java.lang.Boolean|IResolvable getRootTeamsOnlyInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `summaryOnlyInput`Optional + +```java +public java.lang.Boolean|IResolvable getSummaryOnlyInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `resultsPerPage`Required + +```java +public java.lang.Number getResultsPerPage(); +``` + +- *Type:* java.lang.Number + +--- + +##### `rootTeamsOnly`Required + +```java +public java.lang.Boolean|IResolvable getRootTeamsOnly(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `summaryOnly`Required + +```java +public java.lang.Boolean|IResolvable getSummaryOnly(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubOrganizationTeamsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_teams.DataGithubOrganizationTeamsConfig; + +DataGithubOrganizationTeamsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(java.lang.String) +// .resultsPerPage(java.lang.Number) +// .rootTeamsOnly(java.lang.Boolean|IResolvable) +// .summaryOnly(java.lang.Boolean|IResolvable) + .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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_teams#id DataGithubOrganizationTeams#id}. | +| resultsPerPage | java.lang.Number | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_teams#results_per_page DataGithubOrganizationTeams#results_per_page}. | +| rootTeamsOnly | 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_teams#root_teams_only DataGithubOrganizationTeams#root_teams_only}. | +| 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_teams#summary_only DataGithubOrganizationTeams#summary_only}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Optional + +```java +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_teams#id DataGithubOrganizationTeams#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. + +--- + +##### `resultsPerPage`Optional + +```java +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/organization_teams#results_per_page DataGithubOrganizationTeams#results_per_page}. + +--- + +##### `rootTeamsOnly`Optional + +```java +public java.lang.Boolean|IResolvable getRootTeamsOnly(); +``` + +- *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_teams#root_teams_only DataGithubOrganizationTeams#root_teams_only}. + +--- + +##### `summaryOnly`Optional + +```java +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_teams#summary_only DataGithubOrganizationTeams#summary_only}. + +--- + +### DataGithubOrganizationTeamsTeams + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_teams.DataGithubOrganizationTeamsTeams; + +DataGithubOrganizationTeamsTeams.builder() + .build(); +``` + + +## Classes + +### DataGithubOrganizationTeamsTeamsList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_teams.DataGithubOrganizationTeamsTeamsList; + +new DataGithubOrganizationTeamsTeamsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubOrganizationTeamsTeamsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubOrganizationTeamsTeamsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_teams.DataGithubOrganizationTeamsTeamsOutputReference; + +new DataGithubOrganizationTeamsTeamsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| description | java.lang.String | *No description.* | +| id | java.lang.Number | *No description.* | +| members | java.util.List | *No description.* | +| name | java.lang.String | *No description.* | +| nodeId | java.lang.String | *No description.* | +| parent | io.cdktn.cdktn.StringMap | *No description.* | +| parentTeamId | java.lang.String | *No description.* | +| parentTeamSlug | java.lang.String | *No description.* | +| privacy | java.lang.String | *No description.* | +| repositories | java.util.List | *No description.* | +| slug | java.lang.String | *No description.* | +| internalValue | DataGithubOrganizationTeamsTeams | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.Number getId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `members`Required + +```java +public java.util.List getMembers(); +``` + +- *Type:* java.util.List + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `nodeId`Required + +```java +public java.lang.String getNodeId(); +``` + +- *Type:* java.lang.String + +--- + +##### `parent`Required + +```java +public StringMap getParent(); +``` + +- *Type:* io.cdktn.cdktn.StringMap + +--- + +##### `parentTeamId`Required + +```java +public java.lang.String getParentTeamId(); +``` + +- *Type:* java.lang.String + +--- + +##### `parentTeamSlug`Required + +```java +public java.lang.String getParentTeamSlug(); +``` + +- *Type:* java.lang.String + +--- + +##### `privacy`Required + +```java +public java.lang.String getPrivacy(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositories`Required + +```java +public java.util.List getRepositories(); +``` + +- *Type:* java.util.List + +--- + +##### `slug`Required + +```java +public java.lang.String getSlug(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubOrganizationTeamsTeams getInternalValue(); +``` + +- *Type:* DataGithubOrganizationTeamsTeams + +--- + + + diff --git a/docs/dataGithubOrganizationWebhooks.csharp.md b/docs/dataGithubOrganizationWebhooks.csharp.md new file mode 100644 index 000000000..1d0dcc55a --- /dev/null +++ b/docs/dataGithubOrganizationWebhooks.csharp.md @@ -0,0 +1,1208 @@ +# `dataGithubOrganizationWebhooks` Submodule + +## Constructs + +### DataGithubOrganizationWebhooks + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_webhooks github_organization_webhooks}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationWebhooks(Construct Scope, string Id, DataGithubOrganizationWebhooksConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubOrganizationWebhooksConfig | *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`Optional + +- *Type:* DataGithubOrganizationWebhooksConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationWebhooks resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationWebhooks.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationWebhooks.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationWebhooks.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubOrganizationWebhooks.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubOrganizationWebhooks resource upon running "cdktn 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 DataGithubOrganizationWebhooks to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubOrganizationWebhooks that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_webhooks#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubOrganizationWebhooks to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Webhooks | DataGithubOrganizationWebhooksWebhooksList | *No description.* | +| IdInput | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Webhooks`Required + +```csharp +public DataGithubOrganizationWebhooksWebhooksList Webhooks { get; } +``` + +- *Type:* DataGithubOrganizationWebhooksWebhooksList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubOrganizationWebhooksConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationWebhooksConfig { + 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 Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_webhooks#id DataGithubOrganizationWebhooks#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_webhooks#id DataGithubOrganizationWebhooks#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. + +--- + +### DataGithubOrganizationWebhooksWebhooks + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationWebhooksWebhooks { + +}; +``` + + +## Classes + +### DataGithubOrganizationWebhooksWebhooksList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationWebhooksWebhooksList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubOrganizationWebhooksWebhooksOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubOrganizationWebhooksWebhooksOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubOrganizationWebhooksWebhooksOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Active | Io.Cdktn.IResolvable | *No description.* | +| Id | double | *No description.* | +| Name | string | *No description.* | +| Type | string | *No description.* | +| Url | string | *No description.* | +| InternalValue | DataGithubOrganizationWebhooksWebhooks | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Active`Required + +```csharp +public IResolvable Active { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `Id`Required + +```csharp +public double Id { get; } +``` + +- *Type:* double + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Type`Required + +```csharp +public string Type { get; } +``` + +- *Type:* string + +--- + +##### `Url`Required + +```csharp +public string Url { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubOrganizationWebhooksWebhooks InternalValue { get; } +``` + +- *Type:* DataGithubOrganizationWebhooksWebhooks + +--- + + + diff --git a/docs/dataGithubOrganizationWebhooks.java.md b/docs/dataGithubOrganizationWebhooks.java.md new file mode 100644 index 000000000..c426f4c1c --- /dev/null +++ b/docs/dataGithubOrganizationWebhooks.java.md @@ -0,0 +1,1270 @@ +# `dataGithubOrganizationWebhooks` Submodule + +## Constructs + +### DataGithubOrganizationWebhooks + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_webhooks github_organization_webhooks}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_webhooks.DataGithubOrganizationWebhooks; + +DataGithubOrganizationWebhooks.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_webhooks#id DataGithubOrganizationWebhooks#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_webhooks#id DataGithubOrganizationWebhooks#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubOrganizationWebhooks resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_organization_webhooks.DataGithubOrganizationWebhooks; + +DataGithubOrganizationWebhooks.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` + +```java +import io.cdktn.providers.github.data_github_organization_webhooks.DataGithubOrganizationWebhooks; + +DataGithubOrganizationWebhooks.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_organization_webhooks.DataGithubOrganizationWebhooks; + +DataGithubOrganizationWebhooks.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_organization_webhooks.DataGithubOrganizationWebhooks; + +DataGithubOrganizationWebhooks.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubOrganizationWebhooks.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubOrganizationWebhooks 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 DataGithubOrganizationWebhooks to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubOrganizationWebhooks that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_webhooks#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 DataGithubOrganizationWebhooks 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| webhooks | DataGithubOrganizationWebhooksWebhooksList | *No description.* | +| idInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `webhooks`Required + +```java +public DataGithubOrganizationWebhooksWebhooksList getWebhooks(); +``` + +- *Type:* DataGithubOrganizationWebhooksWebhooksList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubOrganizationWebhooksConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_webhooks.DataGithubOrganizationWebhooksConfig; + +DataGithubOrganizationWebhooksConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization_webhooks#id DataGithubOrganizationWebhooks#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Optional + +```java +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_webhooks#id DataGithubOrganizationWebhooks#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. + +--- + +### DataGithubOrganizationWebhooksWebhooks + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_organization_webhooks.DataGithubOrganizationWebhooksWebhooks; + +DataGithubOrganizationWebhooksWebhooks.builder() + .build(); +``` + + +## Classes + +### DataGithubOrganizationWebhooksWebhooksList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_webhooks.DataGithubOrganizationWebhooksWebhooksList; + +new DataGithubOrganizationWebhooksWebhooksList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubOrganizationWebhooksWebhooksOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubOrganizationWebhooksWebhooksOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_organization_webhooks.DataGithubOrganizationWebhooksWebhooksOutputReference; + +new DataGithubOrganizationWebhooksWebhooksOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| active | io.cdktn.cdktn.IResolvable | *No description.* | +| id | java.lang.Number | *No description.* | +| name | java.lang.String | *No description.* | +| type | java.lang.String | *No description.* | +| url | java.lang.String | *No description.* | +| internalValue | DataGithubOrganizationWebhooksWebhooks | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `active`Required + +```java +public IResolvable getActive(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `id`Required + +```java +public java.lang.Number getId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `type`Required + +```java +public java.lang.String getType(); +``` + +- *Type:* java.lang.String + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubOrganizationWebhooksWebhooks getInternalValue(); +``` + +- *Type:* DataGithubOrganizationWebhooksWebhooks + +--- + + + diff --git a/docs/dataGithubRef.csharp.md b/docs/dataGithubRef.csharp.md new file mode 100644 index 000000000..4f33d8b53 --- /dev/null +++ b/docs/dataGithubRef.csharp.md @@ -0,0 +1,849 @@ +# `dataGithubRef` Submodule + +## Constructs + +### DataGithubRef + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref github_ref}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRef(Construct Scope, string Id, DataGithubRefConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubRefConfig | *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:* DataGithubRefConfig + +--- + +#### 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.* | +| ResetOwner | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetOwner` + +```csharp +private void ResetOwner() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubRef resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRef.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRef.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRef.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRef.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubRef resource upon running "cdktn 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 DataGithubRef to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubRef that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubRef to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Etag | string | *No description.* | +| Sha | string | *No description.* | +| IdInput | string | *No description.* | +| OwnerInput | string | *No description.* | +| RefInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Id | string | *No description.* | +| Owner | string | *No description.* | +| Ref | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `Sha`Required + +```csharp +public string Sha { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `OwnerInput`Optional + +```csharp +public string OwnerInput { get; } +``` + +- *Type:* string + +--- + +##### `RefInput`Optional + +```csharp +public string RefInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Owner`Required + +```csharp +public string Owner { get; } +``` + +- *Type:* string + +--- + +##### `Ref`Required + +```csharp +public string Ref { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubRefConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRefConfig { + 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 Ref, + string Repository, + string Id = null, + string Owner = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Ref | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#ref DataGithubRef#ref}. | +| Repository | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#repository DataGithubRef#repository}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#id DataGithubRef#id}. | +| Owner | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#owner DataGithubRef#owner}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Ref`Required + +```csharp +public string Ref { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#ref DataGithubRef#ref}. + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#repository DataGithubRef#repository}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#id DataGithubRef#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. + +--- + +##### `Owner`Optional + +```csharp +public string Owner { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#owner DataGithubRef#owner}. + +--- + + + diff --git a/docs/dataGithubRef.java.md b/docs/dataGithubRef.java.md new file mode 100644 index 000000000..5004e1d3d --- /dev/null +++ b/docs/dataGithubRef.java.md @@ -0,0 +1,942 @@ +# `dataGithubRef` Submodule + +## Constructs + +### DataGithubRef + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref github_ref}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_ref.DataGithubRef; + +DataGithubRef.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .ref(java.lang.String) + .repository(java.lang.String) +// .id(java.lang.String) +// .owner(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 | *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 | *No description.* | +| ref | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#ref DataGithubRef#ref}. | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#repository DataGithubRef#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#id DataGithubRef#id}. | +| owner | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#owner DataGithubRef#owner}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `ref`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#ref DataGithubRef#ref}. + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#repository DataGithubRef#repository}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#id DataGithubRef#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. + +--- + +##### `owner`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#owner DataGithubRef#owner}. + +--- + +#### 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.* | +| resetOwner | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetOwner` + +```java +public void resetOwner() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubRef resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_ref.DataGithubRef; + +DataGithubRef.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` + +```java +import io.cdktn.providers.github.data_github_ref.DataGithubRef; + +DataGithubRef.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_ref.DataGithubRef; + +DataGithubRef.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_ref.DataGithubRef; + +DataGithubRef.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubRef.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubRef 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 DataGithubRef to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubRef that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#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 DataGithubRef 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| etag | java.lang.String | *No description.* | +| sha | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| ownerInput | java.lang.String | *No description.* | +| refInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| owner | java.lang.String | *No description.* | +| ref | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `sha`Required + +```java +public java.lang.String getSha(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `ownerInput`Optional + +```java +public java.lang.String getOwnerInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `refInput`Optional + +```java +public java.lang.String getRefInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `owner`Required + +```java +public java.lang.String getOwner(); +``` + +- *Type:* java.lang.String + +--- + +##### `ref`Required + +```java +public java.lang.String getRef(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubRefConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_ref.DataGithubRefConfig; + +DataGithubRefConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .ref(java.lang.String) + .repository(java.lang.String) +// .id(java.lang.String) +// .owner(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 | *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 | *No description.* | +| ref | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#ref DataGithubRef#ref}. | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#repository DataGithubRef#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#id DataGithubRef#id}. | +| owner | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#owner DataGithubRef#owner}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `ref`Required + +```java +public java.lang.String getRef(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#ref DataGithubRef#ref}. + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#repository DataGithubRef#repository}. + +--- + +##### `id`Optional + +```java +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/ref#id DataGithubRef#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. + +--- + +##### `owner`Optional + +```java +public java.lang.String getOwner(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ref#owner DataGithubRef#owner}. + +--- + + + diff --git a/docs/dataGithubRelease.csharp.md b/docs/dataGithubRelease.csharp.md new file mode 100644 index 000000000..2676e2a50 --- /dev/null +++ b/docs/dataGithubRelease.csharp.md @@ -0,0 +1,1621 @@ +# `dataGithubRelease` Submodule + +## Constructs + +### DataGithubRelease + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release github_release}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRelease(Construct Scope, string Id, DataGithubReleaseConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubReleaseConfig | *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:* DataGithubReleaseConfig + +--- + +#### 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.* | +| ResetReleaseId | *No description.* | +| ResetReleaseTag | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetReleaseId` + +```csharp +private void ResetReleaseId() +``` + +##### `ResetReleaseTag` + +```csharp +private void ResetReleaseTag() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubRelease resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRelease.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRelease.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRelease.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRelease.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubRelease resource upon running "cdktn 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 DataGithubRelease to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubRelease that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubRelease to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| AssertsUrl | string | *No description.* | +| Assets | DataGithubReleaseAssetsList | *No description.* | +| AssetsUrl | string | *No description.* | +| Body | string | *No description.* | +| CreatedAt | string | *No description.* | +| Draft | Io.Cdktn.IResolvable | *No description.* | +| HtmlUrl | string | *No description.* | +| Name | string | *No description.* | +| Prerelease | Io.Cdktn.IResolvable | *No description.* | +| PublishedAt | string | *No description.* | +| TarballUrl | string | *No description.* | +| TargetCommitish | string | *No description.* | +| UploadUrl | string | *No description.* | +| Url | string | *No description.* | +| ZipballUrl | string | *No description.* | +| IdInput | string | *No description.* | +| OwnerInput | string | *No description.* | +| ReleaseIdInput | double | *No description.* | +| ReleaseTagInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| RetrieveByInput | string | *No description.* | +| Id | string | *No description.* | +| Owner | string | *No description.* | +| ReleaseId | double | *No description.* | +| ReleaseTag | string | *No description.* | +| Repository | string | *No description.* | +| RetrieveBy | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `AssertsUrl`Required + +```csharp +public string AssertsUrl { get; } +``` + +- *Type:* string + +--- + +##### `Assets`Required + +```csharp +public DataGithubReleaseAssetsList Assets { get; } +``` + +- *Type:* DataGithubReleaseAssetsList + +--- + +##### `AssetsUrl`Required + +```csharp +public string AssetsUrl { get; } +``` + +- *Type:* string + +--- + +##### `Body`Required + +```csharp +public string Body { get; } +``` + +- *Type:* string + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Draft`Required + +```csharp +public IResolvable Draft { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `HtmlUrl`Required + +```csharp +public string HtmlUrl { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Prerelease`Required + +```csharp +public IResolvable Prerelease { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `PublishedAt`Required + +```csharp +public string PublishedAt { get; } +``` + +- *Type:* string + +--- + +##### `TarballUrl`Required + +```csharp +public string TarballUrl { get; } +``` + +- *Type:* string + +--- + +##### `TargetCommitish`Required + +```csharp +public string TargetCommitish { get; } +``` + +- *Type:* string + +--- + +##### `UploadUrl`Required + +```csharp +public string UploadUrl { get; } +``` + +- *Type:* string + +--- + +##### `Url`Required + +```csharp +public string Url { get; } +``` + +- *Type:* string + +--- + +##### `ZipballUrl`Required + +```csharp +public string ZipballUrl { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `OwnerInput`Optional + +```csharp +public string OwnerInput { get; } +``` + +- *Type:* string + +--- + +##### `ReleaseIdInput`Optional + +```csharp +public double ReleaseIdInput { get; } +``` + +- *Type:* double + +--- + +##### `ReleaseTagInput`Optional + +```csharp +public string ReleaseTagInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `RetrieveByInput`Optional + +```csharp +public string RetrieveByInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Owner`Required + +```csharp +public string Owner { get; } +``` + +- *Type:* string + +--- + +##### `ReleaseId`Required + +```csharp +public double ReleaseId { get; } +``` + +- *Type:* double + +--- + +##### `ReleaseTag`Required + +```csharp +public string ReleaseTag { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `RetrieveBy`Required + +```csharp +public string RetrieveBy { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubReleaseAssets + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubReleaseAssets { + +}; +``` + + +### DataGithubReleaseConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubReleaseConfig { + 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 Owner, + string Repository, + string RetrieveBy, + string Id = null, + double ReleaseId = null, + string ReleaseTag = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Owner | string | Owner of the repository. | +| Repository | string | Name of the repository to retrieve the release from. | +| RetrieveBy | string | Describes how to fetch the release. Valid values are `id`, `tag`, `latest`. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release#id DataGithubRelease#id}. | +| ReleaseId | double | ID of the release to retrieve. Must be specified when `retrieve_by` = `id`. | +| ReleaseTag | string | ID of the release to retrieve. Must be specified when `retrieve_by` = `tag`. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Owner`Required + +```csharp +public string Owner { get; set; } +``` + +- *Type:* string + +Owner of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release#owner DataGithubRelease#owner} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Name of the repository to retrieve the release from. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release#repository DataGithubRelease#repository} + +--- + +##### `RetrieveBy`Required + +```csharp +public string RetrieveBy { get; set; } +``` + +- *Type:* string + +Describes how to fetch the release. Valid values are `id`, `tag`, `latest`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release#retrieve_by DataGithubRelease#retrieve_by} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release#id DataGithubRelease#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. + +--- + +##### `ReleaseId`Optional + +```csharp +public double ReleaseId { get; set; } +``` + +- *Type:* double + +ID of the release to retrieve. Must be specified when `retrieve_by` = `id`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release#release_id DataGithubRelease#release_id} + +--- + +##### `ReleaseTag`Optional + +```csharp +public string ReleaseTag { get; set; } +``` + +- *Type:* string + +ID of the release to retrieve. Must be specified when `retrieve_by` = `tag`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release#release_tag DataGithubRelease#release_tag} + +--- + +## Classes + +### DataGithubReleaseAssetsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubReleaseAssetsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubReleaseAssetsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubReleaseAssetsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubReleaseAssetsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| BrowserDownloadUrl | string | *No description.* | +| ContentType | string | *No description.* | +| CreatedAt | string | *No description.* | +| Id | double | *No description.* | +| Label | string | *No description.* | +| Name | string | *No description.* | +| NodeId | string | *No description.* | +| Size | double | *No description.* | +| UpdatedAt | string | *No description.* | +| Url | string | *No description.* | +| InternalValue | DataGithubReleaseAssets | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `BrowserDownloadUrl`Required + +```csharp +public string BrowserDownloadUrl { get; } +``` + +- *Type:* string + +--- + +##### `ContentType`Required + +```csharp +public string ContentType { get; } +``` + +- *Type:* string + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public double Id { get; } +``` + +- *Type:* double + +--- + +##### `Label`Required + +```csharp +public string Label { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `NodeId`Required + +```csharp +public string NodeId { get; } +``` + +- *Type:* string + +--- + +##### `Size`Required + +```csharp +public double Size { get; } +``` + +- *Type:* double + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Url`Required + +```csharp +public string Url { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubReleaseAssets InternalValue { get; } +``` + +- *Type:* DataGithubReleaseAssets + +--- + + + diff --git a/docs/dataGithubRelease.java.md b/docs/dataGithubRelease.java.md new file mode 100644 index 000000000..bc16f6dd9 --- /dev/null +++ b/docs/dataGithubRelease.java.md @@ -0,0 +1,1743 @@ +# `dataGithubRelease` Submodule + +## Constructs + +### DataGithubRelease + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release github_release}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_release.DataGithubRelease; + +DataGithubRelease.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .owner(java.lang.String) + .repository(java.lang.String) + .retrieveBy(java.lang.String) +// .id(java.lang.String) +// .releaseId(java.lang.Number) +// .releaseTag(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 | *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 | *No description.* | +| owner | java.lang.String | Owner of the repository. | +| repository | java.lang.String | Name of the repository to retrieve the release from. | +| retrieveBy | java.lang.String | Describes how to fetch the release. Valid values are `id`, `tag`, `latest`. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release#id DataGithubRelease#id}. | +| releaseId | java.lang.Number | ID of the release to retrieve. Must be specified when `retrieve_by` = `id`. | +| releaseTag | java.lang.String | ID of the release to retrieve. Must be specified when `retrieve_by` = `tag`. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `owner`Required + +- *Type:* java.lang.String + +Owner of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release#owner DataGithubRelease#owner} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Name of the repository to retrieve the release from. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release#repository DataGithubRelease#repository} + +--- + +##### `retrieveBy`Required + +- *Type:* java.lang.String + +Describes how to fetch the release. Valid values are `id`, `tag`, `latest`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release#retrieve_by DataGithubRelease#retrieve_by} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release#id DataGithubRelease#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. + +--- + +##### `releaseId`Optional + +- *Type:* java.lang.Number + +ID of the release to retrieve. Must be specified when `retrieve_by` = `id`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release#release_id DataGithubRelease#release_id} + +--- + +##### `releaseTag`Optional + +- *Type:* java.lang.String + +ID of the release to retrieve. Must be specified when `retrieve_by` = `tag`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release#release_tag DataGithubRelease#release_tag} + +--- + +#### 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.* | +| resetReleaseId | *No description.* | +| resetReleaseTag | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetReleaseId` + +```java +public void resetReleaseId() +``` + +##### `resetReleaseTag` + +```java +public void resetReleaseTag() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubRelease resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_release.DataGithubRelease; + +DataGithubRelease.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` + +```java +import io.cdktn.providers.github.data_github_release.DataGithubRelease; + +DataGithubRelease.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_release.DataGithubRelease; + +DataGithubRelease.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_release.DataGithubRelease; + +DataGithubRelease.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubRelease.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubRelease 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 DataGithubRelease to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubRelease that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release#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 DataGithubRelease 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| assertsUrl | java.lang.String | *No description.* | +| assets | DataGithubReleaseAssetsList | *No description.* | +| assetsUrl | java.lang.String | *No description.* | +| body | java.lang.String | *No description.* | +| createdAt | java.lang.String | *No description.* | +| draft | io.cdktn.cdktn.IResolvable | *No description.* | +| htmlUrl | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| prerelease | io.cdktn.cdktn.IResolvable | *No description.* | +| publishedAt | java.lang.String | *No description.* | +| tarballUrl | java.lang.String | *No description.* | +| targetCommitish | java.lang.String | *No description.* | +| uploadUrl | java.lang.String | *No description.* | +| url | java.lang.String | *No description.* | +| zipballUrl | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| ownerInput | java.lang.String | *No description.* | +| releaseIdInput | java.lang.Number | *No description.* | +| releaseTagInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| retrieveByInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| owner | java.lang.String | *No description.* | +| releaseId | java.lang.Number | *No description.* | +| releaseTag | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | +| retrieveBy | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `assertsUrl`Required + +```java +public java.lang.String getAssertsUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `assets`Required + +```java +public DataGithubReleaseAssetsList getAssets(); +``` + +- *Type:* DataGithubReleaseAssetsList + +--- + +##### `assetsUrl`Required + +```java +public java.lang.String getAssetsUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `body`Required + +```java +public java.lang.String getBody(); +``` + +- *Type:* java.lang.String + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `draft`Required + +```java +public IResolvable getDraft(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `htmlUrl`Required + +```java +public java.lang.String getHtmlUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `prerelease`Required + +```java +public IResolvable getPrerelease(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `publishedAt`Required + +```java +public java.lang.String getPublishedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `tarballUrl`Required + +```java +public java.lang.String getTarballUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `targetCommitish`Required + +```java +public java.lang.String getTargetCommitish(); +``` + +- *Type:* java.lang.String + +--- + +##### `uploadUrl`Required + +```java +public java.lang.String getUploadUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `zipballUrl`Required + +```java +public java.lang.String getZipballUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `ownerInput`Optional + +```java +public java.lang.String getOwnerInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `releaseIdInput`Optional + +```java +public java.lang.Number getReleaseIdInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `releaseTagInput`Optional + +```java +public java.lang.String getReleaseTagInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `retrieveByInput`Optional + +```java +public java.lang.String getRetrieveByInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `owner`Required + +```java +public java.lang.String getOwner(); +``` + +- *Type:* java.lang.String + +--- + +##### `releaseId`Required + +```java +public java.lang.Number getReleaseId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `releaseTag`Required + +```java +public java.lang.String getReleaseTag(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `retrieveBy`Required + +```java +public java.lang.String getRetrieveBy(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubReleaseAssets + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_release.DataGithubReleaseAssets; + +DataGithubReleaseAssets.builder() + .build(); +``` + + +### DataGithubReleaseConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_release.DataGithubReleaseConfig; + +DataGithubReleaseConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .owner(java.lang.String) + .repository(java.lang.String) + .retrieveBy(java.lang.String) +// .id(java.lang.String) +// .releaseId(java.lang.Number) +// .releaseTag(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 | *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 | *No description.* | +| owner | java.lang.String | Owner of the repository. | +| repository | java.lang.String | Name of the repository to retrieve the release from. | +| retrieveBy | java.lang.String | Describes how to fetch the release. Valid values are `id`, `tag`, `latest`. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release#id DataGithubRelease#id}. | +| releaseId | java.lang.Number | ID of the release to retrieve. Must be specified when `retrieve_by` = `id`. | +| releaseTag | java.lang.String | ID of the release to retrieve. Must be specified when `retrieve_by` = `tag`. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `owner`Required + +```java +public java.lang.String getOwner(); +``` + +- *Type:* java.lang.String + +Owner of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release#owner DataGithubRelease#owner} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Name of the repository to retrieve the release from. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release#repository DataGithubRelease#repository} + +--- + +##### `retrieveBy`Required + +```java +public java.lang.String getRetrieveBy(); +``` + +- *Type:* java.lang.String + +Describes how to fetch the release. Valid values are `id`, `tag`, `latest`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release#retrieve_by DataGithubRelease#retrieve_by} + +--- + +##### `id`Optional + +```java +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/release#id DataGithubRelease#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. + +--- + +##### `releaseId`Optional + +```java +public java.lang.Number getReleaseId(); +``` + +- *Type:* java.lang.Number + +ID of the release to retrieve. Must be specified when `retrieve_by` = `id`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release#release_id DataGithubRelease#release_id} + +--- + +##### `releaseTag`Optional + +```java +public java.lang.String getReleaseTag(); +``` + +- *Type:* java.lang.String + +ID of the release to retrieve. Must be specified when `retrieve_by` = `tag`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release#release_tag DataGithubRelease#release_tag} + +--- + +## Classes + +### DataGithubReleaseAssetsList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_release.DataGithubReleaseAssetsList; + +new DataGithubReleaseAssetsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubReleaseAssetsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubReleaseAssetsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_release.DataGithubReleaseAssetsOutputReference; + +new DataGithubReleaseAssetsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| browserDownloadUrl | java.lang.String | *No description.* | +| contentType | java.lang.String | *No description.* | +| createdAt | java.lang.String | *No description.* | +| id | java.lang.Number | *No description.* | +| label | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| nodeId | java.lang.String | *No description.* | +| size | java.lang.Number | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| url | java.lang.String | *No description.* | +| internalValue | DataGithubReleaseAssets | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `browserDownloadUrl`Required + +```java +public java.lang.String getBrowserDownloadUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `contentType`Required + +```java +public java.lang.String getContentType(); +``` + +- *Type:* java.lang.String + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.Number getId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `label`Required + +```java +public java.lang.String getLabel(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `nodeId`Required + +```java +public java.lang.String getNodeId(); +``` + +- *Type:* java.lang.String + +--- + +##### `size`Required + +```java +public java.lang.Number getSize(); +``` + +- *Type:* java.lang.Number + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubReleaseAssets getInternalValue(); +``` + +- *Type:* DataGithubReleaseAssets + +--- + + + diff --git a/docs/dataGithubReleaseAsset.csharp.md b/docs/dataGithubReleaseAsset.csharp.md new file mode 100644 index 000000000..10173de1d --- /dev/null +++ b/docs/dataGithubReleaseAsset.csharp.md @@ -0,0 +1,981 @@ +# `dataGithubReleaseAsset` Submodule + +## Constructs + +### DataGithubReleaseAsset + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset github_release_asset}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubReleaseAsset(Construct Scope, string Id, DataGithubReleaseAssetConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubReleaseAssetConfig | *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:* DataGithubReleaseAssetConfig + +--- + +#### 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.* | +| ResetDownloadFileContents | *No description.* | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetDownloadFileContents` + +```csharp +private void ResetDownloadFileContents() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubReleaseAsset resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubReleaseAsset.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubReleaseAsset.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubReleaseAsset.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubReleaseAsset.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubReleaseAsset resource upon running "cdktn 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 DataGithubReleaseAsset to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubReleaseAsset that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubReleaseAsset to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| BrowserDownloadUrl | string | *No description.* | +| ContentType | string | *No description.* | +| CreatedAt | string | *No description.* | +| FileContents | string | *No description.* | +| Label | string | *No description.* | +| Name | string | *No description.* | +| NodeId | string | *No description.* | +| Size | double | *No description.* | +| UpdatedAt | string | *No description.* | +| Url | string | *No description.* | +| AssetIdInput | double | *No description.* | +| DownloadFileContentsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| IdInput | string | *No description.* | +| OwnerInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| AssetId | double | *No description.* | +| DownloadFileContents | bool\|Io.Cdktn.IResolvable | *No description.* | +| Id | string | *No description.* | +| Owner | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `BrowserDownloadUrl`Required + +```csharp +public string BrowserDownloadUrl { get; } +``` + +- *Type:* string + +--- + +##### `ContentType`Required + +```csharp +public string ContentType { get; } +``` + +- *Type:* string + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `FileContents`Required + +```csharp +public string FileContents { get; } +``` + +- *Type:* string + +--- + +##### `Label`Required + +```csharp +public string Label { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `NodeId`Required + +```csharp +public string NodeId { get; } +``` + +- *Type:* string + +--- + +##### `Size`Required + +```csharp +public double Size { get; } +``` + +- *Type:* double + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Url`Required + +```csharp +public string Url { get; } +``` + +- *Type:* string + +--- + +##### `AssetIdInput`Optional + +```csharp +public double AssetIdInput { get; } +``` + +- *Type:* double + +--- + +##### `DownloadFileContentsInput`Optional + +```csharp +public bool|IResolvable DownloadFileContentsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `OwnerInput`Optional + +```csharp +public string OwnerInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `AssetId`Required + +```csharp +public double AssetId { get; } +``` + +- *Type:* double + +--- + +##### `DownloadFileContents`Required + +```csharp +public bool|IResolvable DownloadFileContents { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Owner`Required + +```csharp +public string Owner { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubReleaseAssetConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubReleaseAssetConfig { + 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, + double AssetId, + string Owner, + string Repository, + bool|IResolvable DownloadFileContents = null, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| AssetId | double | ID of the release asset to retrieve. | +| Owner | string | Owner of the repository. | +| Repository | string | Name of the repository to retrieve the release asset from. | +| DownloadFileContents | bool\|Io.Cdktn.IResolvable | Whether to download the asset file content into the `file_contents` attribute. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#id DataGithubReleaseAsset#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `AssetId`Required + +```csharp +public double AssetId { get; set; } +``` + +- *Type:* double + +ID of the release asset to retrieve. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#asset_id DataGithubReleaseAsset#asset_id} + +--- + +##### `Owner`Required + +```csharp +public string Owner { get; set; } +``` + +- *Type:* string + +Owner of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#owner DataGithubReleaseAsset#owner} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Name of the repository to retrieve the release asset from. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#repository DataGithubReleaseAsset#repository} + +--- + +##### `DownloadFileContents`Optional + +```csharp +public bool|IResolvable DownloadFileContents { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether to download the asset file content into the `file_contents` attribute. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#download_file_contents DataGithubReleaseAsset#download_file_contents} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#id DataGithubReleaseAsset#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. + +--- + + + diff --git a/docs/dataGithubReleaseAsset.java.md b/docs/dataGithubReleaseAsset.java.md new file mode 100644 index 000000000..a46732abd --- /dev/null +++ b/docs/dataGithubReleaseAsset.java.md @@ -0,0 +1,1092 @@ +# `dataGithubReleaseAsset` Submodule + +## Constructs + +### DataGithubReleaseAsset + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset github_release_asset}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_release_asset.DataGithubReleaseAsset; + +DataGithubReleaseAsset.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .assetId(java.lang.Number) + .owner(java.lang.String) + .repository(java.lang.String) +// .downloadFileContents(java.lang.Boolean|IResolvable) +// .id(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 | *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 | *No description.* | +| assetId | java.lang.Number | ID of the release asset to retrieve. | +| owner | java.lang.String | Owner of the repository. | +| repository | java.lang.String | Name of the repository to retrieve the release asset from. | +| downloadFileContents | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether to download the asset file content into the `file_contents` attribute. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#id DataGithubReleaseAsset#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `assetId`Required + +- *Type:* java.lang.Number + +ID of the release asset to retrieve. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#asset_id DataGithubReleaseAsset#asset_id} + +--- + +##### `owner`Required + +- *Type:* java.lang.String + +Owner of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#owner DataGithubReleaseAsset#owner} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Name of the repository to retrieve the release asset from. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#repository DataGithubReleaseAsset#repository} + +--- + +##### `downloadFileContents`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether to download the asset file content into the `file_contents` attribute. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#download_file_contents DataGithubReleaseAsset#download_file_contents} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#id DataGithubReleaseAsset#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. + +--- + +#### 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.* | +| resetDownloadFileContents | *No description.* | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetDownloadFileContents` + +```java +public void resetDownloadFileContents() +``` + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubReleaseAsset resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_release_asset.DataGithubReleaseAsset; + +DataGithubReleaseAsset.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` + +```java +import io.cdktn.providers.github.data_github_release_asset.DataGithubReleaseAsset; + +DataGithubReleaseAsset.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_release_asset.DataGithubReleaseAsset; + +DataGithubReleaseAsset.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_release_asset.DataGithubReleaseAsset; + +DataGithubReleaseAsset.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubReleaseAsset.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubReleaseAsset 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 DataGithubReleaseAsset to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubReleaseAsset that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#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 DataGithubReleaseAsset 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| browserDownloadUrl | java.lang.String | *No description.* | +| contentType | java.lang.String | *No description.* | +| createdAt | java.lang.String | *No description.* | +| fileContents | java.lang.String | *No description.* | +| label | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| nodeId | java.lang.String | *No description.* | +| size | java.lang.Number | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| url | java.lang.String | *No description.* | +| assetIdInput | java.lang.Number | *No description.* | +| downloadFileContentsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| idInput | java.lang.String | *No description.* | +| ownerInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| assetId | java.lang.Number | *No description.* | +| downloadFileContents | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| id | java.lang.String | *No description.* | +| owner | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `browserDownloadUrl`Required + +```java +public java.lang.String getBrowserDownloadUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `contentType`Required + +```java +public java.lang.String getContentType(); +``` + +- *Type:* java.lang.String + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `fileContents`Required + +```java +public java.lang.String getFileContents(); +``` + +- *Type:* java.lang.String + +--- + +##### `label`Required + +```java +public java.lang.String getLabel(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `nodeId`Required + +```java +public java.lang.String getNodeId(); +``` + +- *Type:* java.lang.String + +--- + +##### `size`Required + +```java +public java.lang.Number getSize(); +``` + +- *Type:* java.lang.Number + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `assetIdInput`Optional + +```java +public java.lang.Number getAssetIdInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `downloadFileContentsInput`Optional + +```java +public java.lang.Boolean|IResolvable getDownloadFileContentsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `ownerInput`Optional + +```java +public java.lang.String getOwnerInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `assetId`Required + +```java +public java.lang.Number getAssetId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `downloadFileContents`Required + +```java +public java.lang.Boolean|IResolvable getDownloadFileContents(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `owner`Required + +```java +public java.lang.String getOwner(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubReleaseAssetConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_release_asset.DataGithubReleaseAssetConfig; + +DataGithubReleaseAssetConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .assetId(java.lang.Number) + .owner(java.lang.String) + .repository(java.lang.String) +// .downloadFileContents(java.lang.Boolean|IResolvable) +// .id(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 | *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 | *No description.* | +| assetId | java.lang.Number | ID of the release asset to retrieve. | +| owner | java.lang.String | Owner of the repository. | +| repository | java.lang.String | Name of the repository to retrieve the release asset from. | +| downloadFileContents | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether to download the asset file content into the `file_contents` attribute. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#id DataGithubReleaseAsset#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `assetId`Required + +```java +public java.lang.Number getAssetId(); +``` + +- *Type:* java.lang.Number + +ID of the release asset to retrieve. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#asset_id DataGithubReleaseAsset#asset_id} + +--- + +##### `owner`Required + +```java +public java.lang.String getOwner(); +``` + +- *Type:* java.lang.String + +Owner of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#owner DataGithubReleaseAsset#owner} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Name of the repository to retrieve the release asset from. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#repository DataGithubReleaseAsset#repository} + +--- + +##### `downloadFileContents`Optional + +```java +public java.lang.Boolean|IResolvable getDownloadFileContents(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether to download the asset file content into the `file_contents` attribute. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/release_asset#download_file_contents DataGithubReleaseAsset#download_file_contents} + +--- + +##### `id`Optional + +```java +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/release_asset#id DataGithubReleaseAsset#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. + +--- + + + diff --git a/docs/dataGithubRepositories.csharp.md b/docs/dataGithubRepositories.csharp.md new file mode 100644 index 000000000..a48cae52c --- /dev/null +++ b/docs/dataGithubRepositories.csharp.md @@ -0,0 +1,910 @@ +# `dataGithubRepositories` Submodule + +## Constructs + +### DataGithubRepositories + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repositories github_repositories}. + +#### Initializers + +```csharp +using Io.Cdktn.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. | +| 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` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetIncludeRepoId` + +```csharp +private void ResetIncludeRepoId() +``` + +##### `ResetResultsPerPage` + +```csharp +private void ResetResultsPerPage() +``` + +##### `ResetSort` + +```csharp +private 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` + +```csharp +using Io.Cdktn.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositories.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositories.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositories.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubRepositories resource upon running "cdktn 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.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.TerraformProvider + +? Optional instance of the provider where the DataGithubRepositories to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| FullNames | string[] | *No description.* | +| Names | string[] | *No description.* | +| RepoIds | double[] | *No description.* | +| IdInput | string | *No description.* | +| IncludeRepoIdInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| QueryInput | string | *No description.* | +| ResultsPerPageInput | double | *No description.* | +| SortInput | string | *No description.* | +| Id | string | *No description.* | +| IncludeRepoId | bool\|Io.Cdktn.IResolvable | *No description.* | +| Query | string | *No description.* | +| ResultsPerPage | double | *No description.* | +| Sort | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `FullNames`Required + +```csharp +public string[] FullNames { get; } +``` + +- *Type:* string[] + +--- + +##### `Names`Required + +```csharp +public string[] Names { get; } +``` + +- *Type:* string[] + +--- + +##### `RepoIds`Required + +```csharp +public double[] RepoIds { get; } +``` + +- *Type:* double[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `IncludeRepoIdInput`Optional + +```csharp +public bool|IResolvable IncludeRepoIdInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `QueryInput`Optional + +```csharp +public string QueryInput { get; } +``` + +- *Type:* string + +--- + +##### `ResultsPerPageInput`Optional + +```csharp +public double ResultsPerPageInput { get; } +``` + +- *Type:* double + +--- + +##### `SortInput`Optional + +```csharp +public string SortInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `IncludeRepoId`Required + +```csharp +public bool|IResolvable IncludeRepoId { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Query`Required + +```csharp +public string Query { get; } +``` + +- *Type:* string + +--- + +##### `ResultsPerPage`Required + +```csharp +public double ResultsPerPage { get; } +``` + +- *Type:* double + +--- + +##### `Sort`Required + +```csharp +public string Sort { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubRepositoriesConfig + +#### Initializer + +```csharp +using Io.Cdktn.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 | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Query | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repositories#query DataGithubRepositories#query}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repositories#id DataGithubRepositories#id}. | +| IncludeRepoId | bool\|Io.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 | double | 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 | 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 + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Query`Required + +```csharp +public string Query { get; set; } +``` + +- *Type:* 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 + +```csharp +public string Id { get; set; } +``` + +- *Type:* 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 + +```csharp +public bool|IResolvable IncludeRepoId { get; set; } +``` + +- *Type:* bool|Io.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 + +```csharp +public double ResultsPerPage { get; set; } +``` + +- *Type:* double + +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 + +```csharp +public string Sort { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repositories#sort DataGithubRepositories#sort}. + +--- + + + diff --git a/docs/dataGithubRepositories.java.md b/docs/dataGithubRepositories.java.md new file mode 100644 index 000000000..51279e2a1 --- /dev/null +++ b/docs/dataGithubRepositories.java.md @@ -0,0 +1,1013 @@ +# `dataGithubRepositories` Submodule + +## Constructs + +### DataGithubRepositories + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repositories github_repositories}. + +#### Initializers + +```java +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) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .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 | *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 | *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 + +--- + +##### `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 + +--- + +##### `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` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetIncludeRepoId` + +```java +public void resetIncludeRepoId() +``` + +##### `resetResultsPerPage` + +```java +public void resetResultsPerPage() +``` + +##### `resetSort` + +```java +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` + +```java +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` + +```java +import io.cdktn.providers.github.data_github_repositories.DataGithubRepositories; + +DataGithubRepositories.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_repositories.DataGithubRepositories; + +DataGithubRepositories.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +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 | *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 | *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 | *No description.* | +| names | java.util.List | *No description.* | +| repoIds | java.util.List | *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 + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `fullNames`Required + +```java +public java.util.List getFullNames(); +``` + +- *Type:* java.util.List + +--- + +##### `names`Required + +```java +public java.util.List getNames(); +``` + +- *Type:* java.util.List + +--- + +##### `repoIds`Required + +```java +public java.util.List getRepoIds(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `includeRepoIdInput`Optional + +```java +public java.lang.Boolean|IResolvable getIncludeRepoIdInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `queryInput`Optional + +```java +public java.lang.String getQueryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `resultsPerPageInput`Optional + +```java +public java.lang.Number getResultsPerPageInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `sortInput`Optional + +```java +public java.lang.String getSortInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `includeRepoId`Required + +```java +public java.lang.Boolean|IResolvable getIncludeRepoId(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `query`Required + +```java +public java.lang.String getQuery(); +``` + +- *Type:* java.lang.String + +--- + +##### `resultsPerPage`Required + +```java +public java.lang.Number getResultsPerPage(); +``` + +- *Type:* java.lang.Number + +--- + +##### `sort`Required + +```java +public java.lang.String getSort(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubRepositoriesConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repositories.DataGithubRepositoriesConfig; + +DataGithubRepositoriesConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .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 | *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 | *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 + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `query`Required + +```java +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 + +```java +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}. + +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 + +```java +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 + +```java +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 + +```java +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}. + +--- + + + diff --git a/docs/dataGithubRepository.csharp.md b/docs/dataGithubRepository.csharp.md new file mode 100644 index 000000000..55f9e0819 --- /dev/null +++ b/docs/dataGithubRepository.csharp.md @@ -0,0 +1,3789 @@ +# `dataGithubRepository` Submodule + +## Constructs + +### DataGithubRepository + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository github_repository}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepository(Construct Scope, string Id, DataGithubRepositoryConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubRepositoryConfig | *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`Optional + +- *Type:* DataGithubRepositoryConfig + +--- + +#### 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.* | +| ResetDescription | *No description.* | +| ResetFullName | *No description.* | +| ResetHomepageUrl | *No description.* | +| ResetId | *No description.* | +| ResetName | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetDescription` + +```csharp +private void ResetDescription() +``` + +##### `ResetFullName` + +```csharp +private void ResetFullName() +``` + +##### `ResetHomepageUrl` + +```csharp +private void ResetHomepageUrl() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetName` + +```csharp +private void ResetName() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubRepository resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepository.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepository.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepository.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepository.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubRepository resource upon running "cdktn 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 DataGithubRepository to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubRepository that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubRepository to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| AllowAutoMerge | Io.Cdktn.IResolvable | *No description.* | +| AllowForking | Io.Cdktn.IResolvable | *No description.* | +| AllowMergeCommit | Io.Cdktn.IResolvable | *No description.* | +| AllowRebaseMerge | Io.Cdktn.IResolvable | *No description.* | +| AllowSquashMerge | Io.Cdktn.IResolvable | *No description.* | +| AllowUpdateBranch | Io.Cdktn.IResolvable | *No description.* | +| Archived | Io.Cdktn.IResolvable | *No description.* | +| DefaultBranch | string | *No description.* | +| DeleteBranchOnMerge | Io.Cdktn.IResolvable | *No description.* | +| Fork | Io.Cdktn.IResolvable | *No description.* | +| GitCloneUrl | string | *No description.* | +| HasDiscussions | Io.Cdktn.IResolvable | *No description.* | +| HasDownloads | Io.Cdktn.IResolvable | *No description.* | +| HasIssues | Io.Cdktn.IResolvable | *No description.* | +| HasProjects | Io.Cdktn.IResolvable | *No description.* | +| HasWiki | Io.Cdktn.IResolvable | *No description.* | +| HtmlUrl | string | *No description.* | +| HttpCloneUrl | string | *No description.* | +| IsTemplate | Io.Cdktn.IResolvable | *No description.* | +| MergeCommitMessage | string | *No description.* | +| MergeCommitTitle | string | *No description.* | +| NodeId | string | *No description.* | +| Pages | DataGithubRepositoryPagesList | *No description.* | +| PrimaryLanguage | string | *No description.* | +| Private | Io.Cdktn.IResolvable | *No description.* | +| RepoId | double | *No description.* | +| RepositoryLicense | DataGithubRepositoryRepositoryLicenseList | *No description.* | +| SquashMergeCommitMessage | string | *No description.* | +| SquashMergeCommitTitle | string | *No description.* | +| SshCloneUrl | string | *No description.* | +| SvnUrl | string | *No description.* | +| Template | DataGithubRepositoryTemplateList | *No description.* | +| Topics | string[] | *No description.* | +| Visibility | string | *No description.* | +| DescriptionInput | string | *No description.* | +| FullNameInput | string | *No description.* | +| HomepageUrlInput | string | *No description.* | +| IdInput | string | *No description.* | +| NameInput | string | *No description.* | +| Description | string | *No description.* | +| FullName | string | *No description.* | +| HomepageUrl | string | *No description.* | +| Id | string | *No description.* | +| Name | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `AllowAutoMerge`Required + +```csharp +public IResolvable AllowAutoMerge { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `AllowForking`Required + +```csharp +public IResolvable AllowForking { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `AllowMergeCommit`Required + +```csharp +public IResolvable AllowMergeCommit { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `AllowRebaseMerge`Required + +```csharp +public IResolvable AllowRebaseMerge { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `AllowSquashMerge`Required + +```csharp +public IResolvable AllowSquashMerge { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `AllowUpdateBranch`Required + +```csharp +public IResolvable AllowUpdateBranch { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `Archived`Required + +```csharp +public IResolvable Archived { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `DefaultBranch`Required + +```csharp +public string DefaultBranch { get; } +``` + +- *Type:* string + +--- + +##### `DeleteBranchOnMerge`Required + +```csharp +public IResolvable DeleteBranchOnMerge { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `Fork`Required + +```csharp +public IResolvable Fork { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `GitCloneUrl`Required + +```csharp +public string GitCloneUrl { get; } +``` + +- *Type:* string + +--- + +##### `HasDiscussions`Required + +```csharp +public IResolvable HasDiscussions { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `HasDownloads`Required + +```csharp +public IResolvable HasDownloads { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `HasIssues`Required + +```csharp +public IResolvable HasIssues { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `HasProjects`Required + +```csharp +public IResolvable HasProjects { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `HasWiki`Required + +```csharp +public IResolvable HasWiki { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `HtmlUrl`Required + +```csharp +public string HtmlUrl { get; } +``` + +- *Type:* string + +--- + +##### `HttpCloneUrl`Required + +```csharp +public string HttpCloneUrl { get; } +``` + +- *Type:* string + +--- + +##### `IsTemplate`Required + +```csharp +public IResolvable IsTemplate { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `MergeCommitMessage`Required + +```csharp +public string MergeCommitMessage { get; } +``` + +- *Type:* string + +--- + +##### `MergeCommitTitle`Required + +```csharp +public string MergeCommitTitle { get; } +``` + +- *Type:* string + +--- + +##### `NodeId`Required + +```csharp +public string NodeId { get; } +``` + +- *Type:* string + +--- + +##### `Pages`Required + +```csharp +public DataGithubRepositoryPagesList Pages { get; } +``` + +- *Type:* DataGithubRepositoryPagesList + +--- + +##### `PrimaryLanguage`Required + +```csharp +public string PrimaryLanguage { get; } +``` + +- *Type:* string + +--- + +##### `Private`Required + +```csharp +public IResolvable Private { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `RepoId`Required + +```csharp +public double RepoId { get; } +``` + +- *Type:* double + +--- + +##### `RepositoryLicense`Required + +```csharp +public DataGithubRepositoryRepositoryLicenseList RepositoryLicense { get; } +``` + +- *Type:* DataGithubRepositoryRepositoryLicenseList + +--- + +##### `SquashMergeCommitMessage`Required + +```csharp +public string SquashMergeCommitMessage { get; } +``` + +- *Type:* string + +--- + +##### `SquashMergeCommitTitle`Required + +```csharp +public string SquashMergeCommitTitle { get; } +``` + +- *Type:* string + +--- + +##### `SshCloneUrl`Required + +```csharp +public string SshCloneUrl { get; } +``` + +- *Type:* string + +--- + +##### `SvnUrl`Required + +```csharp +public string SvnUrl { get; } +``` + +- *Type:* string + +--- + +##### `Template`Required + +```csharp +public DataGithubRepositoryTemplateList Template { get; } +``` + +- *Type:* DataGithubRepositoryTemplateList + +--- + +##### `Topics`Required + +```csharp +public string[] Topics { get; } +``` + +- *Type:* string[] + +--- + +##### `Visibility`Required + +```csharp +public string Visibility { get; } +``` + +- *Type:* string + +--- + +##### `DescriptionInput`Optional + +```csharp +public string DescriptionInput { get; } +``` + +- *Type:* string + +--- + +##### `FullNameInput`Optional + +```csharp +public string FullNameInput { get; } +``` + +- *Type:* string + +--- + +##### `HomepageUrlInput`Optional + +```csharp +public string HomepageUrlInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `FullName`Required + +```csharp +public string FullName { get; } +``` + +- *Type:* string + +--- + +##### `HomepageUrl`Required + +```csharp +public string HomepageUrl { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubRepositoryConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryConfig { + 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 Description = null, + string FullName = null, + string HomepageUrl = null, + string Id = null, + string Name = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Description | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#description DataGithubRepository#description}. | +| FullName | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#full_name DataGithubRepository#full_name}. | +| HomepageUrl | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#homepage_url DataGithubRepository#homepage_url}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#id DataGithubRepository#id}. | +| Name | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#name DataGithubRepository#name}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Description`Optional + +```csharp +public string Description { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#description DataGithubRepository#description}. + +--- + +##### `FullName`Optional + +```csharp +public string FullName { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#full_name DataGithubRepository#full_name}. + +--- + +##### `HomepageUrl`Optional + +```csharp +public string HomepageUrl { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#homepage_url DataGithubRepository#homepage_url}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#id DataGithubRepository#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. + +--- + +##### `Name`Optional + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#name DataGithubRepository#name}. + +--- + +### DataGithubRepositoryPages + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryPages { + +}; +``` + + +### DataGithubRepositoryPagesSource + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryPagesSource { + +}; +``` + + +### DataGithubRepositoryRepositoryLicense + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryRepositoryLicense { + +}; +``` + + +### DataGithubRepositoryRepositoryLicenseLicense + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryRepositoryLicenseLicense { + +}; +``` + + +### DataGithubRepositoryTemplate + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryTemplate { + +}; +``` + + +## Classes + +### DataGithubRepositoryPagesList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryPagesList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubRepositoryPagesOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubRepositoryPagesOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryPagesOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| BuildType | string | *No description.* | +| Cname | string | *No description.* | +| Custom404 | Io.Cdktn.IResolvable | *No description.* | +| HtmlUrl | string | *No description.* | +| Source | DataGithubRepositoryPagesSourceList | *No description.* | +| Status | string | *No description.* | +| Url | string | *No description.* | +| InternalValue | DataGithubRepositoryPages | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `BuildType`Required + +```csharp +public string BuildType { get; } +``` + +- *Type:* string + +--- + +##### `Cname`Required + +```csharp +public string Cname { get; } +``` + +- *Type:* string + +--- + +##### `Custom404`Required + +```csharp +public IResolvable Custom404 { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `HtmlUrl`Required + +```csharp +public string HtmlUrl { get; } +``` + +- *Type:* string + +--- + +##### `Source`Required + +```csharp +public DataGithubRepositoryPagesSourceList Source { get; } +``` + +- *Type:* DataGithubRepositoryPagesSourceList + +--- + +##### `Status`Required + +```csharp +public string Status { get; } +``` + +- *Type:* string + +--- + +##### `Url`Required + +```csharp +public string Url { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubRepositoryPages InternalValue { get; } +``` + +- *Type:* DataGithubRepositoryPages + +--- + + +### DataGithubRepositoryPagesSourceList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryPagesSourceList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubRepositoryPagesSourceOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubRepositoryPagesSourceOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryPagesSourceOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Branch | string | *No description.* | +| Path | string | *No description.* | +| InternalValue | DataGithubRepositoryPagesSource | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Branch`Required + +```csharp +public string Branch { get; } +``` + +- *Type:* string + +--- + +##### `Path`Required + +```csharp +public string Path { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubRepositoryPagesSource InternalValue { get; } +``` + +- *Type:* DataGithubRepositoryPagesSource + +--- + + +### DataGithubRepositoryRepositoryLicenseLicenseList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryRepositoryLicenseLicenseList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubRepositoryRepositoryLicenseLicenseOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubRepositoryRepositoryLicenseLicenseOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryRepositoryLicenseLicenseOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Body | string | *No description.* | +| Conditions | string[] | *No description.* | +| Description | string | *No description.* | +| Featured | Io.Cdktn.IResolvable | *No description.* | +| HtmlUrl | string | *No description.* | +| Implementation | string | *No description.* | +| Key | string | *No description.* | +| Limitations | string[] | *No description.* | +| Name | string | *No description.* | +| Permissions | string[] | *No description.* | +| SpdxId | string | *No description.* | +| Url | string | *No description.* | +| InternalValue | DataGithubRepositoryRepositoryLicenseLicense | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Body`Required + +```csharp +public string Body { get; } +``` + +- *Type:* string + +--- + +##### `Conditions`Required + +```csharp +public string[] Conditions { get; } +``` + +- *Type:* string[] + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `Featured`Required + +```csharp +public IResolvable Featured { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `HtmlUrl`Required + +```csharp +public string HtmlUrl { get; } +``` + +- *Type:* string + +--- + +##### `Implementation`Required + +```csharp +public string Implementation { get; } +``` + +- *Type:* string + +--- + +##### `Key`Required + +```csharp +public string Key { get; } +``` + +- *Type:* string + +--- + +##### `Limitations`Required + +```csharp +public string[] Limitations { get; } +``` + +- *Type:* string[] + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Permissions`Required + +```csharp +public string[] Permissions { get; } +``` + +- *Type:* string[] + +--- + +##### `SpdxId`Required + +```csharp +public string SpdxId { get; } +``` + +- *Type:* string + +--- + +##### `Url`Required + +```csharp +public string Url { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubRepositoryRepositoryLicenseLicense InternalValue { get; } +``` + +- *Type:* DataGithubRepositoryRepositoryLicenseLicense + +--- + + +### DataGithubRepositoryRepositoryLicenseList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryRepositoryLicenseList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubRepositoryRepositoryLicenseOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubRepositoryRepositoryLicenseOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryRepositoryLicenseOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Content | string | *No description.* | +| DownloadUrl | string | *No description.* | +| Encoding | string | *No description.* | +| GitUrl | string | *No description.* | +| HtmlUrl | string | *No description.* | +| License | DataGithubRepositoryRepositoryLicenseLicenseList | *No description.* | +| Name | string | *No description.* | +| Path | string | *No description.* | +| Sha | string | *No description.* | +| Size | double | *No description.* | +| Type | string | *No description.* | +| Url | string | *No description.* | +| InternalValue | DataGithubRepositoryRepositoryLicense | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Content`Required + +```csharp +public string Content { get; } +``` + +- *Type:* string + +--- + +##### `DownloadUrl`Required + +```csharp +public string DownloadUrl { get; } +``` + +- *Type:* string + +--- + +##### `Encoding`Required + +```csharp +public string Encoding { get; } +``` + +- *Type:* string + +--- + +##### `GitUrl`Required + +```csharp +public string GitUrl { get; } +``` + +- *Type:* string + +--- + +##### `HtmlUrl`Required + +```csharp +public string HtmlUrl { get; } +``` + +- *Type:* string + +--- + +##### `License`Required + +```csharp +public DataGithubRepositoryRepositoryLicenseLicenseList License { get; } +``` + +- *Type:* DataGithubRepositoryRepositoryLicenseLicenseList + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Path`Required + +```csharp +public string Path { get; } +``` + +- *Type:* string + +--- + +##### `Sha`Required + +```csharp +public string Sha { get; } +``` + +- *Type:* string + +--- + +##### `Size`Required + +```csharp +public double Size { get; } +``` + +- *Type:* double + +--- + +##### `Type`Required + +```csharp +public string Type { get; } +``` + +- *Type:* string + +--- + +##### `Url`Required + +```csharp +public string Url { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubRepositoryRepositoryLicense InternalValue { get; } +``` + +- *Type:* DataGithubRepositoryRepositoryLicense + +--- + + +### DataGithubRepositoryTemplateList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryTemplateList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubRepositoryTemplateOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubRepositoryTemplateOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryTemplateOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Owner | string | *No description.* | +| Repository | string | *No description.* | +| InternalValue | DataGithubRepositoryTemplate | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Owner`Required + +```csharp +public string Owner { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubRepositoryTemplate InternalValue { get; } +``` + +- *Type:* DataGithubRepositoryTemplate + +--- + + + diff --git a/docs/dataGithubRepository.java.md b/docs/dataGithubRepository.java.md new file mode 100644 index 000000000..7d9cdae29 --- /dev/null +++ b/docs/dataGithubRepository.java.md @@ -0,0 +1,3887 @@ +# `dataGithubRepository` Submodule + +## Constructs + +### DataGithubRepository + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository github_repository}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository.DataGithubRepository; + +DataGithubRepository.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .description(java.lang.String) +// .fullName(java.lang.String) +// .homepageUrl(java.lang.String) +// .id(java.lang.String) +// .name(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 | *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 | *No description.* | +| description | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#description DataGithubRepository#description}. | +| fullName | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#full_name DataGithubRepository#full_name}. | +| homepageUrl | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#homepage_url DataGithubRepository#homepage_url}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#id DataGithubRepository#id}. | +| name | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#name DataGithubRepository#name}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `description`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#description DataGithubRepository#description}. + +--- + +##### `fullName`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#full_name DataGithubRepository#full_name}. + +--- + +##### `homepageUrl`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#homepage_url DataGithubRepository#homepage_url}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#id DataGithubRepository#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. + +--- + +##### `name`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#name DataGithubRepository#name}. + +--- + +#### 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.* | +| resetDescription | *No description.* | +| resetFullName | *No description.* | +| resetHomepageUrl | *No description.* | +| resetId | *No description.* | +| resetName | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetDescription` + +```java +public void resetDescription() +``` + +##### `resetFullName` + +```java +public void resetFullName() +``` + +##### `resetHomepageUrl` + +```java +public void resetHomepageUrl() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetName` + +```java +public void resetName() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubRepository resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_repository.DataGithubRepository; + +DataGithubRepository.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` + +```java +import io.cdktn.providers.github.data_github_repository.DataGithubRepository; + +DataGithubRepository.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_repository.DataGithubRepository; + +DataGithubRepository.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_repository.DataGithubRepository; + +DataGithubRepository.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubRepository.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubRepository 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 DataGithubRepository to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubRepository that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#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 DataGithubRepository 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| allowAutoMerge | io.cdktn.cdktn.IResolvable | *No description.* | +| allowForking | io.cdktn.cdktn.IResolvable | *No description.* | +| allowMergeCommit | io.cdktn.cdktn.IResolvable | *No description.* | +| allowRebaseMerge | io.cdktn.cdktn.IResolvable | *No description.* | +| allowSquashMerge | io.cdktn.cdktn.IResolvable | *No description.* | +| allowUpdateBranch | io.cdktn.cdktn.IResolvable | *No description.* | +| archived | io.cdktn.cdktn.IResolvable | *No description.* | +| defaultBranch | java.lang.String | *No description.* | +| deleteBranchOnMerge | io.cdktn.cdktn.IResolvable | *No description.* | +| fork | io.cdktn.cdktn.IResolvable | *No description.* | +| gitCloneUrl | java.lang.String | *No description.* | +| hasDiscussions | io.cdktn.cdktn.IResolvable | *No description.* | +| hasDownloads | io.cdktn.cdktn.IResolvable | *No description.* | +| hasIssues | io.cdktn.cdktn.IResolvable | *No description.* | +| hasProjects | io.cdktn.cdktn.IResolvable | *No description.* | +| hasWiki | io.cdktn.cdktn.IResolvable | *No description.* | +| htmlUrl | java.lang.String | *No description.* | +| httpCloneUrl | java.lang.String | *No description.* | +| isTemplate | io.cdktn.cdktn.IResolvable | *No description.* | +| mergeCommitMessage | java.lang.String | *No description.* | +| mergeCommitTitle | java.lang.String | *No description.* | +| nodeId | java.lang.String | *No description.* | +| pages | DataGithubRepositoryPagesList | *No description.* | +| primaryLanguage | java.lang.String | *No description.* | +| private | io.cdktn.cdktn.IResolvable | *No description.* | +| repoId | java.lang.Number | *No description.* | +| repositoryLicense | DataGithubRepositoryRepositoryLicenseList | *No description.* | +| squashMergeCommitMessage | java.lang.String | *No description.* | +| squashMergeCommitTitle | java.lang.String | *No description.* | +| sshCloneUrl | java.lang.String | *No description.* | +| svnUrl | java.lang.String | *No description.* | +| template | DataGithubRepositoryTemplateList | *No description.* | +| topics | java.util.List | *No description.* | +| visibility | java.lang.String | *No description.* | +| descriptionInput | java.lang.String | *No description.* | +| fullNameInput | java.lang.String | *No description.* | +| homepageUrlInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| description | java.lang.String | *No description.* | +| fullName | java.lang.String | *No description.* | +| homepageUrl | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `allowAutoMerge`Required + +```java +public IResolvable getAllowAutoMerge(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `allowForking`Required + +```java +public IResolvable getAllowForking(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `allowMergeCommit`Required + +```java +public IResolvable getAllowMergeCommit(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `allowRebaseMerge`Required + +```java +public IResolvable getAllowRebaseMerge(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `allowSquashMerge`Required + +```java +public IResolvable getAllowSquashMerge(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `allowUpdateBranch`Required + +```java +public IResolvable getAllowUpdateBranch(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `archived`Required + +```java +public IResolvable getArchived(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `defaultBranch`Required + +```java +public java.lang.String getDefaultBranch(); +``` + +- *Type:* java.lang.String + +--- + +##### `deleteBranchOnMerge`Required + +```java +public IResolvable getDeleteBranchOnMerge(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `fork`Required + +```java +public IResolvable getFork(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `gitCloneUrl`Required + +```java +public java.lang.String getGitCloneUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `hasDiscussions`Required + +```java +public IResolvable getHasDiscussions(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `hasDownloads`Required + +```java +public IResolvable getHasDownloads(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `hasIssues`Required + +```java +public IResolvable getHasIssues(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `hasProjects`Required + +```java +public IResolvable getHasProjects(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `hasWiki`Required + +```java +public IResolvable getHasWiki(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `htmlUrl`Required + +```java +public java.lang.String getHtmlUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `httpCloneUrl`Required + +```java +public java.lang.String getHttpCloneUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `isTemplate`Required + +```java +public IResolvable getIsTemplate(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `mergeCommitMessage`Required + +```java +public java.lang.String getMergeCommitMessage(); +``` + +- *Type:* java.lang.String + +--- + +##### `mergeCommitTitle`Required + +```java +public java.lang.String getMergeCommitTitle(); +``` + +- *Type:* java.lang.String + +--- + +##### `nodeId`Required + +```java +public java.lang.String getNodeId(); +``` + +- *Type:* java.lang.String + +--- + +##### `pages`Required + +```java +public DataGithubRepositoryPagesList getPages(); +``` + +- *Type:* DataGithubRepositoryPagesList + +--- + +##### `primaryLanguage`Required + +```java +public java.lang.String getPrimaryLanguage(); +``` + +- *Type:* java.lang.String + +--- + +##### `private`Required + +```java +public IResolvable getPrivate(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `repoId`Required + +```java +public java.lang.Number getRepoId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `repositoryLicense`Required + +```java +public DataGithubRepositoryRepositoryLicenseList getRepositoryLicense(); +``` + +- *Type:* DataGithubRepositoryRepositoryLicenseList + +--- + +##### `squashMergeCommitMessage`Required + +```java +public java.lang.String getSquashMergeCommitMessage(); +``` + +- *Type:* java.lang.String + +--- + +##### `squashMergeCommitTitle`Required + +```java +public java.lang.String getSquashMergeCommitTitle(); +``` + +- *Type:* java.lang.String + +--- + +##### `sshCloneUrl`Required + +```java +public java.lang.String getSshCloneUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `svnUrl`Required + +```java +public java.lang.String getSvnUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `template`Required + +```java +public DataGithubRepositoryTemplateList getTemplate(); +``` + +- *Type:* DataGithubRepositoryTemplateList + +--- + +##### `topics`Required + +```java +public java.util.List getTopics(); +``` + +- *Type:* java.util.List + +--- + +##### `visibility`Required + +```java +public java.lang.String getVisibility(); +``` + +- *Type:* java.lang.String + +--- + +##### `descriptionInput`Optional + +```java +public java.lang.String getDescriptionInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `fullNameInput`Optional + +```java +public java.lang.String getFullNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `homepageUrlInput`Optional + +```java +public java.lang.String getHomepageUrlInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `fullName`Required + +```java +public java.lang.String getFullName(); +``` + +- *Type:* java.lang.String + +--- + +##### `homepageUrl`Required + +```java +public java.lang.String getHomepageUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubRepositoryConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository.DataGithubRepositoryConfig; + +DataGithubRepositoryConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .description(java.lang.String) +// .fullName(java.lang.String) +// .homepageUrl(java.lang.String) +// .id(java.lang.String) +// .name(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 | *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 | *No description.* | +| description | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#description DataGithubRepository#description}. | +| fullName | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#full_name DataGithubRepository#full_name}. | +| homepageUrl | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#homepage_url DataGithubRepository#homepage_url}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#id DataGithubRepository#id}. | +| name | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#name DataGithubRepository#name}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `description`Optional + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#description DataGithubRepository#description}. + +--- + +##### `fullName`Optional + +```java +public java.lang.String getFullName(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#full_name DataGithubRepository#full_name}. + +--- + +##### `homepageUrl`Optional + +```java +public java.lang.String getHomepageUrl(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository#homepage_url DataGithubRepository#homepage_url}. + +--- + +##### `id`Optional + +```java +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/repository#id DataGithubRepository#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. + +--- + +##### `name`Optional + +```java +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/repository#name DataGithubRepository#name}. + +--- + +### DataGithubRepositoryPages + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository.DataGithubRepositoryPages; + +DataGithubRepositoryPages.builder() + .build(); +``` + + +### DataGithubRepositoryPagesSource + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository.DataGithubRepositoryPagesSource; + +DataGithubRepositoryPagesSource.builder() + .build(); +``` + + +### DataGithubRepositoryRepositoryLicense + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository.DataGithubRepositoryRepositoryLicense; + +DataGithubRepositoryRepositoryLicense.builder() + .build(); +``` + + +### DataGithubRepositoryRepositoryLicenseLicense + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository.DataGithubRepositoryRepositoryLicenseLicense; + +DataGithubRepositoryRepositoryLicenseLicense.builder() + .build(); +``` + + +### DataGithubRepositoryTemplate + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository.DataGithubRepositoryTemplate; + +DataGithubRepositoryTemplate.builder() + .build(); +``` + + +## Classes + +### DataGithubRepositoryPagesList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository.DataGithubRepositoryPagesList; + +new DataGithubRepositoryPagesList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubRepositoryPagesOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubRepositoryPagesOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository.DataGithubRepositoryPagesOutputReference; + +new DataGithubRepositoryPagesOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| buildType | java.lang.String | *No description.* | +| cname | java.lang.String | *No description.* | +| custom404 | io.cdktn.cdktn.IResolvable | *No description.* | +| htmlUrl | java.lang.String | *No description.* | +| source | DataGithubRepositoryPagesSourceList | *No description.* | +| status | java.lang.String | *No description.* | +| url | java.lang.String | *No description.* | +| internalValue | DataGithubRepositoryPages | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `buildType`Required + +```java +public java.lang.String getBuildType(); +``` + +- *Type:* java.lang.String + +--- + +##### `cname`Required + +```java +public java.lang.String getCname(); +``` + +- *Type:* java.lang.String + +--- + +##### `custom404`Required + +```java +public IResolvable getCustom404(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `htmlUrl`Required + +```java +public java.lang.String getHtmlUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `source`Required + +```java +public DataGithubRepositoryPagesSourceList getSource(); +``` + +- *Type:* DataGithubRepositoryPagesSourceList + +--- + +##### `status`Required + +```java +public java.lang.String getStatus(); +``` + +- *Type:* java.lang.String + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubRepositoryPages getInternalValue(); +``` + +- *Type:* DataGithubRepositoryPages + +--- + + +### DataGithubRepositoryPagesSourceList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository.DataGithubRepositoryPagesSourceList; + +new DataGithubRepositoryPagesSourceList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubRepositoryPagesSourceOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubRepositoryPagesSourceOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository.DataGithubRepositoryPagesSourceOutputReference; + +new DataGithubRepositoryPagesSourceOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| branch | java.lang.String | *No description.* | +| path | java.lang.String | *No description.* | +| internalValue | DataGithubRepositoryPagesSource | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `branch`Required + +```java +public java.lang.String getBranch(); +``` + +- *Type:* java.lang.String + +--- + +##### `path`Required + +```java +public java.lang.String getPath(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubRepositoryPagesSource getInternalValue(); +``` + +- *Type:* DataGithubRepositoryPagesSource + +--- + + +### DataGithubRepositoryRepositoryLicenseLicenseList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository.DataGithubRepositoryRepositoryLicenseLicenseList; + +new DataGithubRepositoryRepositoryLicenseLicenseList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubRepositoryRepositoryLicenseLicenseOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubRepositoryRepositoryLicenseLicenseOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository.DataGithubRepositoryRepositoryLicenseLicenseOutputReference; + +new DataGithubRepositoryRepositoryLicenseLicenseOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| body | java.lang.String | *No description.* | +| conditions | java.util.List | *No description.* | +| description | java.lang.String | *No description.* | +| featured | io.cdktn.cdktn.IResolvable | *No description.* | +| htmlUrl | java.lang.String | *No description.* | +| implementation | java.lang.String | *No description.* | +| key | java.lang.String | *No description.* | +| limitations | java.util.List | *No description.* | +| name | java.lang.String | *No description.* | +| permissions | java.util.List | *No description.* | +| spdxId | java.lang.String | *No description.* | +| url | java.lang.String | *No description.* | +| internalValue | DataGithubRepositoryRepositoryLicenseLicense | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `body`Required + +```java +public java.lang.String getBody(); +``` + +- *Type:* java.lang.String + +--- + +##### `conditions`Required + +```java +public java.util.List getConditions(); +``` + +- *Type:* java.util.List + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `featured`Required + +```java +public IResolvable getFeatured(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `htmlUrl`Required + +```java +public java.lang.String getHtmlUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `implementation`Required + +```java +public java.lang.String getImplementation(); +``` + +- *Type:* java.lang.String + +--- + +##### `key`Required + +```java +public java.lang.String getKey(); +``` + +- *Type:* java.lang.String + +--- + +##### `limitations`Required + +```java +public java.util.List getLimitations(); +``` + +- *Type:* java.util.List + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `permissions`Required + +```java +public java.util.List getPermissions(); +``` + +- *Type:* java.util.List + +--- + +##### `spdxId`Required + +```java +public java.lang.String getSpdxId(); +``` + +- *Type:* java.lang.String + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubRepositoryRepositoryLicenseLicense getInternalValue(); +``` + +- *Type:* DataGithubRepositoryRepositoryLicenseLicense + +--- + + +### DataGithubRepositoryRepositoryLicenseList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository.DataGithubRepositoryRepositoryLicenseList; + +new DataGithubRepositoryRepositoryLicenseList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubRepositoryRepositoryLicenseOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubRepositoryRepositoryLicenseOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository.DataGithubRepositoryRepositoryLicenseOutputReference; + +new DataGithubRepositoryRepositoryLicenseOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| content | java.lang.String | *No description.* | +| downloadUrl | java.lang.String | *No description.* | +| encoding | java.lang.String | *No description.* | +| gitUrl | java.lang.String | *No description.* | +| htmlUrl | java.lang.String | *No description.* | +| license | DataGithubRepositoryRepositoryLicenseLicenseList | *No description.* | +| name | java.lang.String | *No description.* | +| path | java.lang.String | *No description.* | +| sha | java.lang.String | *No description.* | +| size | java.lang.Number | *No description.* | +| type | java.lang.String | *No description.* | +| url | java.lang.String | *No description.* | +| internalValue | DataGithubRepositoryRepositoryLicense | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `content`Required + +```java +public java.lang.String getContent(); +``` + +- *Type:* java.lang.String + +--- + +##### `downloadUrl`Required + +```java +public java.lang.String getDownloadUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `encoding`Required + +```java +public java.lang.String getEncoding(); +``` + +- *Type:* java.lang.String + +--- + +##### `gitUrl`Required + +```java +public java.lang.String getGitUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `htmlUrl`Required + +```java +public java.lang.String getHtmlUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `license`Required + +```java +public DataGithubRepositoryRepositoryLicenseLicenseList getLicense(); +``` + +- *Type:* DataGithubRepositoryRepositoryLicenseLicenseList + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `path`Required + +```java +public java.lang.String getPath(); +``` + +- *Type:* java.lang.String + +--- + +##### `sha`Required + +```java +public java.lang.String getSha(); +``` + +- *Type:* java.lang.String + +--- + +##### `size`Required + +```java +public java.lang.Number getSize(); +``` + +- *Type:* java.lang.Number + +--- + +##### `type`Required + +```java +public java.lang.String getType(); +``` + +- *Type:* java.lang.String + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubRepositoryRepositoryLicense getInternalValue(); +``` + +- *Type:* DataGithubRepositoryRepositoryLicense + +--- + + +### DataGithubRepositoryTemplateList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository.DataGithubRepositoryTemplateList; + +new DataGithubRepositoryTemplateList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubRepositoryTemplateOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubRepositoryTemplateOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository.DataGithubRepositoryTemplateOutputReference; + +new DataGithubRepositoryTemplateOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| owner | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | +| internalValue | DataGithubRepositoryTemplate | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `owner`Required + +```java +public java.lang.String getOwner(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubRepositoryTemplate getInternalValue(); +``` + +- *Type:* DataGithubRepositoryTemplate + +--- + + + diff --git a/docs/dataGithubRepositoryAutolinkReferences.csharp.md b/docs/dataGithubRepositoryAutolinkReferences.csharp.md new file mode 100644 index 000000000..b7ce1d1a9 --- /dev/null +++ b/docs/dataGithubRepositoryAutolinkReferences.csharp.md @@ -0,0 +1,1222 @@ +# `dataGithubRepositoryAutolinkReferences` Submodule + +## Constructs + +### DataGithubRepositoryAutolinkReferences + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_autolink_references github_repository_autolink_references}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryAutolinkReferences(Construct Scope, string Id, DataGithubRepositoryAutolinkReferencesConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubRepositoryAutolinkReferencesConfig | *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:* DataGithubRepositoryAutolinkReferencesConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryAutolinkReferences resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryAutolinkReferences.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryAutolinkReferences.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryAutolinkReferences.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryAutolinkReferences.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubRepositoryAutolinkReferences resource upon running "cdktn 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 DataGithubRepositoryAutolinkReferences to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubRepositoryAutolinkReferences that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_autolink_references#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubRepositoryAutolinkReferences to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| AutolinkReferences | DataGithubRepositoryAutolinkReferencesAutolinkReferencesList | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `AutolinkReferences`Required + +```csharp +public DataGithubRepositoryAutolinkReferencesAutolinkReferencesList AutolinkReferences { get; } +``` + +- *Type:* DataGithubRepositoryAutolinkReferencesAutolinkReferencesList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubRepositoryAutolinkReferencesAutolinkReferences + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryAutolinkReferencesAutolinkReferences { + +}; +``` + + +### DataGithubRepositoryAutolinkReferencesConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryAutolinkReferencesConfig { + 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 Repository, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_autolink_references#repository DataGithubRepositoryAutolinkReferences#repository}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_autolink_references#id DataGithubRepositoryAutolinkReferences#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_autolink_references#repository DataGithubRepositoryAutolinkReferences#repository}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_autolink_references#id DataGithubRepositoryAutolinkReferences#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. + +--- + +## Classes + +### DataGithubRepositoryAutolinkReferencesAutolinkReferencesList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryAutolinkReferencesAutolinkReferencesList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubRepositoryAutolinkReferencesAutolinkReferencesOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubRepositoryAutolinkReferencesAutolinkReferencesOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryAutolinkReferencesAutolinkReferencesOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| IsAlphanumeric | Io.Cdktn.IResolvable | *No description.* | +| KeyPrefix | string | *No description.* | +| TargetUrlTemplate | string | *No description.* | +| InternalValue | DataGithubRepositoryAutolinkReferencesAutolinkReferences | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `IsAlphanumeric`Required + +```csharp +public IResolvable IsAlphanumeric { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `KeyPrefix`Required + +```csharp +public string KeyPrefix { get; } +``` + +- *Type:* string + +--- + +##### `TargetUrlTemplate`Required + +```csharp +public string TargetUrlTemplate { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubRepositoryAutolinkReferencesAutolinkReferences InternalValue { get; } +``` + +- *Type:* DataGithubRepositoryAutolinkReferencesAutolinkReferences + +--- + + + diff --git a/docs/dataGithubRepositoryAutolinkReferences.java.md b/docs/dataGithubRepositoryAutolinkReferences.java.md new file mode 100644 index 000000000..1d3674594 --- /dev/null +++ b/docs/dataGithubRepositoryAutolinkReferences.java.md @@ -0,0 +1,1294 @@ +# `dataGithubRepositoryAutolinkReferences` Submodule + +## Constructs + +### DataGithubRepositoryAutolinkReferences + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_autolink_references github_repository_autolink_references}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_autolink_references.DataGithubRepositoryAutolinkReferences; + +DataGithubRepositoryAutolinkReferences.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_autolink_references#repository DataGithubRepositoryAutolinkReferences#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_autolink_references#id DataGithubRepositoryAutolinkReferences#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_autolink_references#repository DataGithubRepositoryAutolinkReferences#repository}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_autolink_references#id DataGithubRepositoryAutolinkReferences#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryAutolinkReferences resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_repository_autolink_references.DataGithubRepositoryAutolinkReferences; + +DataGithubRepositoryAutolinkReferences.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` + +```java +import io.cdktn.providers.github.data_github_repository_autolink_references.DataGithubRepositoryAutolinkReferences; + +DataGithubRepositoryAutolinkReferences.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_repository_autolink_references.DataGithubRepositoryAutolinkReferences; + +DataGithubRepositoryAutolinkReferences.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_repository_autolink_references.DataGithubRepositoryAutolinkReferences; + +DataGithubRepositoryAutolinkReferences.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubRepositoryAutolinkReferences.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubRepositoryAutolinkReferences 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 DataGithubRepositoryAutolinkReferences to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubRepositoryAutolinkReferences that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_autolink_references#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 DataGithubRepositoryAutolinkReferences 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| autolinkReferences | DataGithubRepositoryAutolinkReferencesAutolinkReferencesList | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `autolinkReferences`Required + +```java +public DataGithubRepositoryAutolinkReferencesAutolinkReferencesList getAutolinkReferences(); +``` + +- *Type:* DataGithubRepositoryAutolinkReferencesAutolinkReferencesList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubRepositoryAutolinkReferencesAutolinkReferences + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_autolink_references.DataGithubRepositoryAutolinkReferencesAutolinkReferences; + +DataGithubRepositoryAutolinkReferencesAutolinkReferences.builder() + .build(); +``` + + +### DataGithubRepositoryAutolinkReferencesConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_autolink_references.DataGithubRepositoryAutolinkReferencesConfig; + +DataGithubRepositoryAutolinkReferencesConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_autolink_references#repository DataGithubRepositoryAutolinkReferences#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_autolink_references#id DataGithubRepositoryAutolinkReferences#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_autolink_references#repository DataGithubRepositoryAutolinkReferences#repository}. + +--- + +##### `id`Optional + +```java +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/repository_autolink_references#id DataGithubRepositoryAutolinkReferences#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. + +--- + +## Classes + +### DataGithubRepositoryAutolinkReferencesAutolinkReferencesList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_autolink_references.DataGithubRepositoryAutolinkReferencesAutolinkReferencesList; + +new DataGithubRepositoryAutolinkReferencesAutolinkReferencesList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubRepositoryAutolinkReferencesAutolinkReferencesOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubRepositoryAutolinkReferencesAutolinkReferencesOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_autolink_references.DataGithubRepositoryAutolinkReferencesAutolinkReferencesOutputReference; + +new DataGithubRepositoryAutolinkReferencesAutolinkReferencesOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| isAlphanumeric | io.cdktn.cdktn.IResolvable | *No description.* | +| keyPrefix | java.lang.String | *No description.* | +| targetUrlTemplate | java.lang.String | *No description.* | +| internalValue | DataGithubRepositoryAutolinkReferencesAutolinkReferences | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `isAlphanumeric`Required + +```java +public IResolvable getIsAlphanumeric(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `keyPrefix`Required + +```java +public java.lang.String getKeyPrefix(); +``` + +- *Type:* java.lang.String + +--- + +##### `targetUrlTemplate`Required + +```java +public java.lang.String getTargetUrlTemplate(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubRepositoryAutolinkReferencesAutolinkReferences getInternalValue(); +``` + +- *Type:* DataGithubRepositoryAutolinkReferencesAutolinkReferences + +--- + + + diff --git a/docs/dataGithubRepositoryBranches.csharp.md b/docs/dataGithubRepositoryBranches.csharp.md new file mode 100644 index 000000000..7bf814473 --- /dev/null +++ b/docs/dataGithubRepositoryBranches.csharp.md @@ -0,0 +1,1297 @@ +# `dataGithubRepositoryBranches` Submodule + +## Constructs + +### DataGithubRepositoryBranches + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_branches github_repository_branches}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryBranches(Construct Scope, string Id, DataGithubRepositoryBranchesConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubRepositoryBranchesConfig | *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:* DataGithubRepositoryBranchesConfig + +--- + +#### 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.* | +| ResetOnlyNonProtectedBranches | *No description.* | +| ResetOnlyProtectedBranches | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetOnlyNonProtectedBranches` + +```csharp +private void ResetOnlyNonProtectedBranches() +``` + +##### `ResetOnlyProtectedBranches` + +```csharp +private void ResetOnlyProtectedBranches() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryBranches resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryBranches.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryBranches.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryBranches.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryBranches.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubRepositoryBranches resource upon running "cdktn 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 DataGithubRepositoryBranches to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubRepositoryBranches that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_branches#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubRepositoryBranches to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Branches | DataGithubRepositoryBranchesBranchesList | *No description.* | +| IdInput | string | *No description.* | +| OnlyNonProtectedBranchesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| OnlyProtectedBranchesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RepositoryInput | string | *No description.* | +| Id | string | *No description.* | +| OnlyNonProtectedBranches | bool\|Io.Cdktn.IResolvable | *No description.* | +| OnlyProtectedBranches | bool\|Io.Cdktn.IResolvable | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Branches`Required + +```csharp +public DataGithubRepositoryBranchesBranchesList Branches { get; } +``` + +- *Type:* DataGithubRepositoryBranchesBranchesList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `OnlyNonProtectedBranchesInput`Optional + +```csharp +public bool|IResolvable OnlyNonProtectedBranchesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `OnlyProtectedBranchesInput`Optional + +```csharp +public bool|IResolvable OnlyProtectedBranchesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `OnlyNonProtectedBranches`Required + +```csharp +public bool|IResolvable OnlyNonProtectedBranches { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `OnlyProtectedBranches`Required + +```csharp +public bool|IResolvable OnlyProtectedBranches { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubRepositoryBranchesBranches + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryBranchesBranches { + +}; +``` + + +### DataGithubRepositoryBranchesConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryBranchesConfig { + 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 Repository, + string Id = null, + bool|IResolvable OnlyNonProtectedBranches = null, + bool|IResolvable OnlyProtectedBranches = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_branches#repository DataGithubRepositoryBranches#repository}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_branches#id DataGithubRepositoryBranches#id}. | +| OnlyNonProtectedBranches | bool\|Io.Cdktn.IResolvable | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_branches#only_non_protected_branches DataGithubRepositoryBranches#only_non_protected_branches}. | +| OnlyProtectedBranches | bool\|Io.Cdktn.IResolvable | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_branches#only_protected_branches DataGithubRepositoryBranches#only_protected_branches}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_branches#repository DataGithubRepositoryBranches#repository}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_branches#id DataGithubRepositoryBranches#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. + +--- + +##### `OnlyNonProtectedBranches`Optional + +```csharp +public bool|IResolvable OnlyNonProtectedBranches { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_branches#only_non_protected_branches DataGithubRepositoryBranches#only_non_protected_branches}. + +--- + +##### `OnlyProtectedBranches`Optional + +```csharp +public bool|IResolvable OnlyProtectedBranches { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_branches#only_protected_branches DataGithubRepositoryBranches#only_protected_branches}. + +--- + +## Classes + +### DataGithubRepositoryBranchesBranchesList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryBranchesBranchesList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubRepositoryBranchesBranchesOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubRepositoryBranchesBranchesOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryBranchesBranchesOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Name | string | *No description.* | +| Protected | Io.Cdktn.IResolvable | *No description.* | +| InternalValue | DataGithubRepositoryBranchesBranches | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Protected`Required + +```csharp +public IResolvable Protected { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubRepositoryBranchesBranches InternalValue { get; } +``` + +- *Type:* DataGithubRepositoryBranchesBranches + +--- + + + diff --git a/docs/dataGithubRepositoryBranches.java.md b/docs/dataGithubRepositoryBranches.java.md new file mode 100644 index 000000000..2ae0cd52e --- /dev/null +++ b/docs/dataGithubRepositoryBranches.java.md @@ -0,0 +1,1389 @@ +# `dataGithubRepositoryBranches` Submodule + +## Constructs + +### DataGithubRepositoryBranches + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_branches github_repository_branches}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_branches.DataGithubRepositoryBranches; + +DataGithubRepositoryBranches.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(java.lang.String) +// .onlyNonProtectedBranches(java.lang.Boolean|IResolvable) +// .onlyProtectedBranches(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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_branches#repository DataGithubRepositoryBranches#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_branches#id DataGithubRepositoryBranches#id}. | +| onlyNonProtectedBranches | 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/repository_branches#only_non_protected_branches DataGithubRepositoryBranches#only_non_protected_branches}. | +| onlyProtectedBranches | 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/repository_branches#only_protected_branches DataGithubRepositoryBranches#only_protected_branches}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_branches#repository DataGithubRepositoryBranches#repository}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_branches#id DataGithubRepositoryBranches#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. + +--- + +##### `onlyNonProtectedBranches`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/repository_branches#only_non_protected_branches DataGithubRepositoryBranches#only_non_protected_branches}. + +--- + +##### `onlyProtectedBranches`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/repository_branches#only_protected_branches DataGithubRepositoryBranches#only_protected_branches}. + +--- + +#### 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.* | +| resetOnlyNonProtectedBranches | *No description.* | +| resetOnlyProtectedBranches | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetOnlyNonProtectedBranches` + +```java +public void resetOnlyNonProtectedBranches() +``` + +##### `resetOnlyProtectedBranches` + +```java +public void resetOnlyProtectedBranches() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryBranches resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_repository_branches.DataGithubRepositoryBranches; + +DataGithubRepositoryBranches.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` + +```java +import io.cdktn.providers.github.data_github_repository_branches.DataGithubRepositoryBranches; + +DataGithubRepositoryBranches.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_repository_branches.DataGithubRepositoryBranches; + +DataGithubRepositoryBranches.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_repository_branches.DataGithubRepositoryBranches; + +DataGithubRepositoryBranches.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubRepositoryBranches.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubRepositoryBranches 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 DataGithubRepositoryBranches to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubRepositoryBranches that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_branches#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 DataGithubRepositoryBranches 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| branches | DataGithubRepositoryBranchesBranchesList | *No description.* | +| idInput | java.lang.String | *No description.* | +| onlyNonProtectedBranchesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| onlyProtectedBranchesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| onlyNonProtectedBranches | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| onlyProtectedBranches | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `branches`Required + +```java +public DataGithubRepositoryBranchesBranchesList getBranches(); +``` + +- *Type:* DataGithubRepositoryBranchesBranchesList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `onlyNonProtectedBranchesInput`Optional + +```java +public java.lang.Boolean|IResolvable getOnlyNonProtectedBranchesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `onlyProtectedBranchesInput`Optional + +```java +public java.lang.Boolean|IResolvable getOnlyProtectedBranchesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `onlyNonProtectedBranches`Required + +```java +public java.lang.Boolean|IResolvable getOnlyNonProtectedBranches(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `onlyProtectedBranches`Required + +```java +public java.lang.Boolean|IResolvable getOnlyProtectedBranches(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubRepositoryBranchesBranches + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_branches.DataGithubRepositoryBranchesBranches; + +DataGithubRepositoryBranchesBranches.builder() + .build(); +``` + + +### DataGithubRepositoryBranchesConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_branches.DataGithubRepositoryBranchesConfig; + +DataGithubRepositoryBranchesConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(java.lang.String) +// .onlyNonProtectedBranches(java.lang.Boolean|IResolvable) +// .onlyProtectedBranches(java.lang.Boolean|IResolvable) + .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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_branches#repository DataGithubRepositoryBranches#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_branches#id DataGithubRepositoryBranches#id}. | +| onlyNonProtectedBranches | 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/repository_branches#only_non_protected_branches DataGithubRepositoryBranches#only_non_protected_branches}. | +| onlyProtectedBranches | 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/repository_branches#only_protected_branches DataGithubRepositoryBranches#only_protected_branches}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_branches#repository DataGithubRepositoryBranches#repository}. + +--- + +##### `id`Optional + +```java +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/repository_branches#id DataGithubRepositoryBranches#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. + +--- + +##### `onlyNonProtectedBranches`Optional + +```java +public java.lang.Boolean|IResolvable getOnlyNonProtectedBranches(); +``` + +- *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/repository_branches#only_non_protected_branches DataGithubRepositoryBranches#only_non_protected_branches}. + +--- + +##### `onlyProtectedBranches`Optional + +```java +public java.lang.Boolean|IResolvable getOnlyProtectedBranches(); +``` + +- *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/repository_branches#only_protected_branches DataGithubRepositoryBranches#only_protected_branches}. + +--- + +## Classes + +### DataGithubRepositoryBranchesBranchesList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_branches.DataGithubRepositoryBranchesBranchesList; + +new DataGithubRepositoryBranchesBranchesList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubRepositoryBranchesBranchesOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubRepositoryBranchesBranchesOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_branches.DataGithubRepositoryBranchesBranchesOutputReference; + +new DataGithubRepositoryBranchesBranchesOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| protected | io.cdktn.cdktn.IResolvable | *No description.* | +| internalValue | DataGithubRepositoryBranchesBranches | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `protected`Required + +```java +public IResolvable getProtected(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `internalValue`Optional + +```java +public DataGithubRepositoryBranchesBranches getInternalValue(); +``` + +- *Type:* DataGithubRepositoryBranchesBranches + +--- + + + diff --git a/docs/dataGithubRepositoryCustomProperties.csharp.md b/docs/dataGithubRepositoryCustomProperties.csharp.md new file mode 100644 index 000000000..ef53e9e2c --- /dev/null +++ b/docs/dataGithubRepositoryCustomProperties.csharp.md @@ -0,0 +1,1213 @@ +# `dataGithubRepositoryCustomProperties` Submodule + +## Constructs + +### DataGithubRepositoryCustomProperties + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_custom_properties github_repository_custom_properties}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryCustomProperties(Construct Scope, string Id, DataGithubRepositoryCustomPropertiesConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubRepositoryCustomPropertiesConfig | *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:* DataGithubRepositoryCustomPropertiesConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryCustomProperties resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryCustomProperties.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryCustomProperties.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryCustomProperties.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryCustomProperties.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubRepositoryCustomProperties resource upon running "cdktn 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 DataGithubRepositoryCustomProperties to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubRepositoryCustomProperties that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_custom_properties#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubRepositoryCustomProperties to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Property | DataGithubRepositoryCustomPropertiesPropertyList | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Property`Required + +```csharp +public DataGithubRepositoryCustomPropertiesPropertyList Property { get; } +``` + +- *Type:* DataGithubRepositoryCustomPropertiesPropertyList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubRepositoryCustomPropertiesConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryCustomPropertiesConfig { + 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 Repository, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | Name of the repository which the custom properties should be on. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_custom_properties#id DataGithubRepositoryCustomProperties#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Name of the repository which the custom properties should be on. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_custom_properties#repository DataGithubRepositoryCustomProperties#repository} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_custom_properties#id DataGithubRepositoryCustomProperties#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. + +--- + +### DataGithubRepositoryCustomPropertiesProperty + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryCustomPropertiesProperty { + +}; +``` + + +## Classes + +### DataGithubRepositoryCustomPropertiesPropertyList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryCustomPropertiesPropertyList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubRepositoryCustomPropertiesPropertyOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubRepositoryCustomPropertiesPropertyOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryCustomPropertiesPropertyOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| PropertyName | string | *No description.* | +| PropertyValue | string[] | *No description.* | +| InternalValue | DataGithubRepositoryCustomPropertiesProperty | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `PropertyName`Required + +```csharp +public string PropertyName { get; } +``` + +- *Type:* string + +--- + +##### `PropertyValue`Required + +```csharp +public string[] PropertyValue { get; } +``` + +- *Type:* string[] + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubRepositoryCustomPropertiesProperty InternalValue { get; } +``` + +- *Type:* DataGithubRepositoryCustomPropertiesProperty + +--- + + + diff --git a/docs/dataGithubRepositoryCustomProperties.java.md b/docs/dataGithubRepositoryCustomProperties.java.md new file mode 100644 index 000000000..0ccc7f17c --- /dev/null +++ b/docs/dataGithubRepositoryCustomProperties.java.md @@ -0,0 +1,1287 @@ +# `dataGithubRepositoryCustomProperties` Submodule + +## Constructs + +### DataGithubRepositoryCustomProperties + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_custom_properties github_repository_custom_properties}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_custom_properties.DataGithubRepositoryCustomProperties; + +DataGithubRepositoryCustomProperties.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Name of the repository which the custom properties should be on. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_custom_properties#id DataGithubRepositoryCustomProperties#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Name of the repository which the custom properties should be on. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_custom_properties#repository DataGithubRepositoryCustomProperties#repository} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_custom_properties#id DataGithubRepositoryCustomProperties#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryCustomProperties resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_repository_custom_properties.DataGithubRepositoryCustomProperties; + +DataGithubRepositoryCustomProperties.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` + +```java +import io.cdktn.providers.github.data_github_repository_custom_properties.DataGithubRepositoryCustomProperties; + +DataGithubRepositoryCustomProperties.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_repository_custom_properties.DataGithubRepositoryCustomProperties; + +DataGithubRepositoryCustomProperties.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_repository_custom_properties.DataGithubRepositoryCustomProperties; + +DataGithubRepositoryCustomProperties.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubRepositoryCustomProperties.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubRepositoryCustomProperties 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 DataGithubRepositoryCustomProperties to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubRepositoryCustomProperties that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_custom_properties#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 DataGithubRepositoryCustomProperties 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| property | DataGithubRepositoryCustomPropertiesPropertyList | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `property`Required + +```java +public DataGithubRepositoryCustomPropertiesPropertyList getProperty(); +``` + +- *Type:* DataGithubRepositoryCustomPropertiesPropertyList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubRepositoryCustomPropertiesConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_custom_properties.DataGithubRepositoryCustomPropertiesConfig; + +DataGithubRepositoryCustomPropertiesConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Name of the repository which the custom properties should be on. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_custom_properties#id DataGithubRepositoryCustomProperties#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Name of the repository which the custom properties should be on. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_custom_properties#repository DataGithubRepositoryCustomProperties#repository} + +--- + +##### `id`Optional + +```java +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/repository_custom_properties#id DataGithubRepositoryCustomProperties#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. + +--- + +### DataGithubRepositoryCustomPropertiesProperty + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_custom_properties.DataGithubRepositoryCustomPropertiesProperty; + +DataGithubRepositoryCustomPropertiesProperty.builder() + .build(); +``` + + +## Classes + +### DataGithubRepositoryCustomPropertiesPropertyList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_custom_properties.DataGithubRepositoryCustomPropertiesPropertyList; + +new DataGithubRepositoryCustomPropertiesPropertyList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubRepositoryCustomPropertiesPropertyOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubRepositoryCustomPropertiesPropertyOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_custom_properties.DataGithubRepositoryCustomPropertiesPropertyOutputReference; + +new DataGithubRepositoryCustomPropertiesPropertyOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| propertyName | java.lang.String | *No description.* | +| propertyValue | java.util.List | *No description.* | +| internalValue | DataGithubRepositoryCustomPropertiesProperty | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `propertyName`Required + +```java +public java.lang.String getPropertyName(); +``` + +- *Type:* java.lang.String + +--- + +##### `propertyValue`Required + +```java +public java.util.List getPropertyValue(); +``` + +- *Type:* java.util.List + +--- + +##### `internalValue`Optional + +```java +public DataGithubRepositoryCustomPropertiesProperty getInternalValue(); +``` + +- *Type:* DataGithubRepositoryCustomPropertiesProperty + +--- + + + diff --git a/docs/dataGithubRepositoryDeployKeys.csharp.md b/docs/dataGithubRepositoryDeployKeys.csharp.md new file mode 100644 index 000000000..0e548da1d --- /dev/null +++ b/docs/dataGithubRepositoryDeployKeys.csharp.md @@ -0,0 +1,1233 @@ +# `dataGithubRepositoryDeployKeys` Submodule + +## Constructs + +### DataGithubRepositoryDeployKeys + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deploy_keys github_repository_deploy_keys}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryDeployKeys(Construct Scope, string Id, DataGithubRepositoryDeployKeysConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubRepositoryDeployKeysConfig | *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:* DataGithubRepositoryDeployKeysConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryDeployKeys resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryDeployKeys.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryDeployKeys.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryDeployKeys.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryDeployKeys.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubRepositoryDeployKeys resource upon running "cdktn 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 DataGithubRepositoryDeployKeys to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubRepositoryDeployKeys that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deploy_keys#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubRepositoryDeployKeys to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Keys | DataGithubRepositoryDeployKeysKeysList | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Keys`Required + +```csharp +public DataGithubRepositoryDeployKeysKeysList Keys { get; } +``` + +- *Type:* DataGithubRepositoryDeployKeysKeysList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubRepositoryDeployKeysConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryDeployKeysConfig { + 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 Repository, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deploy_keys#repository DataGithubRepositoryDeployKeys#repository}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deploy_keys#id DataGithubRepositoryDeployKeys#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deploy_keys#repository DataGithubRepositoryDeployKeys#repository}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deploy_keys#id DataGithubRepositoryDeployKeys#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. + +--- + +### DataGithubRepositoryDeployKeysKeys + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryDeployKeysKeys { + +}; +``` + + +## Classes + +### DataGithubRepositoryDeployKeysKeysList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryDeployKeysKeysList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubRepositoryDeployKeysKeysOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubRepositoryDeployKeysKeysOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryDeployKeysKeysOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Id | double | *No description.* | +| Key | string | *No description.* | +| Title | string | *No description.* | +| Verified | Io.Cdktn.IResolvable | *No description.* | +| InternalValue | DataGithubRepositoryDeployKeysKeys | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public double Id { get; } +``` + +- *Type:* double + +--- + +##### `Key`Required + +```csharp +public string Key { get; } +``` + +- *Type:* string + +--- + +##### `Title`Required + +```csharp +public string Title { get; } +``` + +- *Type:* string + +--- + +##### `Verified`Required + +```csharp +public IResolvable Verified { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubRepositoryDeployKeysKeys InternalValue { get; } +``` + +- *Type:* DataGithubRepositoryDeployKeysKeys + +--- + + + diff --git a/docs/dataGithubRepositoryDeployKeys.java.md b/docs/dataGithubRepositoryDeployKeys.java.md new file mode 100644 index 000000000..c8d58c404 --- /dev/null +++ b/docs/dataGithubRepositoryDeployKeys.java.md @@ -0,0 +1,1305 @@ +# `dataGithubRepositoryDeployKeys` Submodule + +## Constructs + +### DataGithubRepositoryDeployKeys + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deploy_keys github_repository_deploy_keys}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_deploy_keys.DataGithubRepositoryDeployKeys; + +DataGithubRepositoryDeployKeys.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deploy_keys#repository DataGithubRepositoryDeployKeys#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deploy_keys#id DataGithubRepositoryDeployKeys#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deploy_keys#repository DataGithubRepositoryDeployKeys#repository}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deploy_keys#id DataGithubRepositoryDeployKeys#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryDeployKeys resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_repository_deploy_keys.DataGithubRepositoryDeployKeys; + +DataGithubRepositoryDeployKeys.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` + +```java +import io.cdktn.providers.github.data_github_repository_deploy_keys.DataGithubRepositoryDeployKeys; + +DataGithubRepositoryDeployKeys.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_repository_deploy_keys.DataGithubRepositoryDeployKeys; + +DataGithubRepositoryDeployKeys.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_repository_deploy_keys.DataGithubRepositoryDeployKeys; + +DataGithubRepositoryDeployKeys.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubRepositoryDeployKeys.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubRepositoryDeployKeys 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 DataGithubRepositoryDeployKeys to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubRepositoryDeployKeys that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deploy_keys#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 DataGithubRepositoryDeployKeys 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| keys | DataGithubRepositoryDeployKeysKeysList | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `keys`Required + +```java +public DataGithubRepositoryDeployKeysKeysList getKeys(); +``` + +- *Type:* DataGithubRepositoryDeployKeysKeysList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubRepositoryDeployKeysConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_deploy_keys.DataGithubRepositoryDeployKeysConfig; + +DataGithubRepositoryDeployKeysConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deploy_keys#repository DataGithubRepositoryDeployKeys#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deploy_keys#id DataGithubRepositoryDeployKeys#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deploy_keys#repository DataGithubRepositoryDeployKeys#repository}. + +--- + +##### `id`Optional + +```java +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/repository_deploy_keys#id DataGithubRepositoryDeployKeys#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. + +--- + +### DataGithubRepositoryDeployKeysKeys + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_deploy_keys.DataGithubRepositoryDeployKeysKeys; + +DataGithubRepositoryDeployKeysKeys.builder() + .build(); +``` + + +## Classes + +### DataGithubRepositoryDeployKeysKeysList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_deploy_keys.DataGithubRepositoryDeployKeysKeysList; + +new DataGithubRepositoryDeployKeysKeysList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubRepositoryDeployKeysKeysOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubRepositoryDeployKeysKeysOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_deploy_keys.DataGithubRepositoryDeployKeysKeysOutputReference; + +new DataGithubRepositoryDeployKeysKeysOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| id | java.lang.Number | *No description.* | +| key | java.lang.String | *No description.* | +| title | java.lang.String | *No description.* | +| verified | io.cdktn.cdktn.IResolvable | *No description.* | +| internalValue | DataGithubRepositoryDeployKeysKeys | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.Number getId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `key`Required + +```java +public java.lang.String getKey(); +``` + +- *Type:* java.lang.String + +--- + +##### `title`Required + +```java +public java.lang.String getTitle(); +``` + +- *Type:* java.lang.String + +--- + +##### `verified`Required + +```java +public IResolvable getVerified(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `internalValue`Optional + +```java +public DataGithubRepositoryDeployKeysKeys getInternalValue(); +``` + +- *Type:* DataGithubRepositoryDeployKeysKeys + +--- + + + diff --git a/docs/dataGithubRepositoryDeploymentBranchPolicies.csharp.md b/docs/dataGithubRepositoryDeploymentBranchPolicies.csharp.md new file mode 100644 index 000000000..5dfe34cd9 --- /dev/null +++ b/docs/dataGithubRepositoryDeploymentBranchPolicies.csharp.md @@ -0,0 +1,1251 @@ +# `dataGithubRepositoryDeploymentBranchPolicies` Submodule + +## Constructs + +### DataGithubRepositoryDeploymentBranchPolicies + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deployment_branch_policies github_repository_deployment_branch_policies}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryDeploymentBranchPolicies(Construct Scope, string Id, DataGithubRepositoryDeploymentBranchPoliciesConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubRepositoryDeploymentBranchPoliciesConfig | *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:* DataGithubRepositoryDeploymentBranchPoliciesConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryDeploymentBranchPolicies resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryDeploymentBranchPolicies.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryDeploymentBranchPolicies.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryDeploymentBranchPolicies.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryDeploymentBranchPolicies.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubRepositoryDeploymentBranchPolicies resource upon running "cdktn 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 DataGithubRepositoryDeploymentBranchPolicies to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubRepositoryDeploymentBranchPolicies that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deployment_branch_policies#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubRepositoryDeploymentBranchPolicies to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| DeploymentBranchPolicies | DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPoliciesList | *No description.* | +| EnvironmentNameInput | string | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| EnvironmentName | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `DeploymentBranchPolicies`Required + +```csharp +public DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPoliciesList DeploymentBranchPolicies { get; } +``` + +- *Type:* DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPoliciesList + +--- + +##### `EnvironmentNameInput`Optional + +```csharp +public string EnvironmentNameInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `EnvironmentName`Required + +```csharp +public string EnvironmentName { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubRepositoryDeploymentBranchPoliciesConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryDeploymentBranchPoliciesConfig { + 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 EnvironmentName, + string Repository, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| EnvironmentName | string | The target environment name. | +| Repository | string | The GitHub repository name. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deployment_branch_policies#id DataGithubRepositoryDeploymentBranchPolicies#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `EnvironmentName`Required + +```csharp +public string EnvironmentName { get; set; } +``` + +- *Type:* string + +The target environment name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deployment_branch_policies#environment_name DataGithubRepositoryDeploymentBranchPolicies#environment_name} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The GitHub repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deployment_branch_policies#repository DataGithubRepositoryDeploymentBranchPolicies#repository} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deployment_branch_policies#id DataGithubRepositoryDeploymentBranchPolicies#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. + +--- + +### DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPolicies + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPolicies { + +}; +``` + + +## Classes + +### DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPoliciesList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPoliciesList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPoliciesOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPoliciesOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPoliciesOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Id | string | *No description.* | +| Name | string | *No description.* | +| InternalValue | DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPolicies | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPolicies InternalValue { get; } +``` + +- *Type:* DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPolicies + +--- + + + diff --git a/docs/dataGithubRepositoryDeploymentBranchPolicies.java.md b/docs/dataGithubRepositoryDeploymentBranchPolicies.java.md new file mode 100644 index 000000000..d75c2588f --- /dev/null +++ b/docs/dataGithubRepositoryDeploymentBranchPolicies.java.md @@ -0,0 +1,1337 @@ +# `dataGithubRepositoryDeploymentBranchPolicies` Submodule + +## Constructs + +### DataGithubRepositoryDeploymentBranchPolicies + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deployment_branch_policies github_repository_deployment_branch_policies}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_deployment_branch_policies.DataGithubRepositoryDeploymentBranchPolicies; + +DataGithubRepositoryDeploymentBranchPolicies.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .environmentName(java.lang.String) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| environmentName | java.lang.String | The target environment name. | +| repository | java.lang.String | The GitHub repository name. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deployment_branch_policies#id DataGithubRepositoryDeploymentBranchPolicies#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `environmentName`Required + +- *Type:* java.lang.String + +The target environment name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deployment_branch_policies#environment_name DataGithubRepositoryDeploymentBranchPolicies#environment_name} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The GitHub repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deployment_branch_policies#repository DataGithubRepositoryDeploymentBranchPolicies#repository} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deployment_branch_policies#id DataGithubRepositoryDeploymentBranchPolicies#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryDeploymentBranchPolicies resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_repository_deployment_branch_policies.DataGithubRepositoryDeploymentBranchPolicies; + +DataGithubRepositoryDeploymentBranchPolicies.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` + +```java +import io.cdktn.providers.github.data_github_repository_deployment_branch_policies.DataGithubRepositoryDeploymentBranchPolicies; + +DataGithubRepositoryDeploymentBranchPolicies.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_repository_deployment_branch_policies.DataGithubRepositoryDeploymentBranchPolicies; + +DataGithubRepositoryDeploymentBranchPolicies.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_repository_deployment_branch_policies.DataGithubRepositoryDeploymentBranchPolicies; + +DataGithubRepositoryDeploymentBranchPolicies.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubRepositoryDeploymentBranchPolicies.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubRepositoryDeploymentBranchPolicies 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 DataGithubRepositoryDeploymentBranchPolicies to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubRepositoryDeploymentBranchPolicies that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deployment_branch_policies#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 DataGithubRepositoryDeploymentBranchPolicies 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| deploymentBranchPolicies | DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPoliciesList | *No description.* | +| environmentNameInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| environmentName | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `deploymentBranchPolicies`Required + +```java +public DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPoliciesList getDeploymentBranchPolicies(); +``` + +- *Type:* DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPoliciesList + +--- + +##### `environmentNameInput`Optional + +```java +public java.lang.String getEnvironmentNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `environmentName`Required + +```java +public java.lang.String getEnvironmentName(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubRepositoryDeploymentBranchPoliciesConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_deployment_branch_policies.DataGithubRepositoryDeploymentBranchPoliciesConfig; + +DataGithubRepositoryDeploymentBranchPoliciesConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .environmentName(java.lang.String) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| environmentName | java.lang.String | The target environment name. | +| repository | java.lang.String | The GitHub repository name. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deployment_branch_policies#id DataGithubRepositoryDeploymentBranchPolicies#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `environmentName`Required + +```java +public java.lang.String getEnvironmentName(); +``` + +- *Type:* java.lang.String + +The target environment name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deployment_branch_policies#environment_name DataGithubRepositoryDeploymentBranchPolicies#environment_name} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The GitHub repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_deployment_branch_policies#repository DataGithubRepositoryDeploymentBranchPolicies#repository} + +--- + +##### `id`Optional + +```java +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/repository_deployment_branch_policies#id DataGithubRepositoryDeploymentBranchPolicies#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. + +--- + +### DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPolicies + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_deployment_branch_policies.DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPolicies; + +DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPolicies.builder() + .build(); +``` + + +## Classes + +### DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPoliciesList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_deployment_branch_policies.DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPoliciesList; + +new DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPoliciesList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPoliciesOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPoliciesOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_deployment_branch_policies.DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPoliciesOutputReference; + +new DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPoliciesOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| internalValue | DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPolicies | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPolicies getInternalValue(); +``` + +- *Type:* DataGithubRepositoryDeploymentBranchPoliciesDeploymentBranchPolicies + +--- + + + diff --git a/docs/dataGithubRepositoryEnvironmentDeploymentPolicies.csharp.md b/docs/dataGithubRepositoryEnvironmentDeploymentPolicies.csharp.md new file mode 100644 index 000000000..0ca8b46b1 --- /dev/null +++ b/docs/dataGithubRepositoryEnvironmentDeploymentPolicies.csharp.md @@ -0,0 +1,1251 @@ +# `dataGithubRepositoryEnvironmentDeploymentPolicies` Submodule + +## Constructs + +### DataGithubRepositoryEnvironmentDeploymentPolicies + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environment_deployment_policies github_repository_environment_deployment_policies}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryEnvironmentDeploymentPolicies(Construct Scope, string Id, DataGithubRepositoryEnvironmentDeploymentPoliciesConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubRepositoryEnvironmentDeploymentPoliciesConfig | *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:* DataGithubRepositoryEnvironmentDeploymentPoliciesConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryEnvironmentDeploymentPolicies resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryEnvironmentDeploymentPolicies.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryEnvironmentDeploymentPolicies.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryEnvironmentDeploymentPolicies.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryEnvironmentDeploymentPolicies.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubRepositoryEnvironmentDeploymentPolicies resource upon running "cdktn 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 DataGithubRepositoryEnvironmentDeploymentPolicies to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubRepositoryEnvironmentDeploymentPolicies that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environment_deployment_policies#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubRepositoryEnvironmentDeploymentPolicies to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Policies | DataGithubRepositoryEnvironmentDeploymentPoliciesPoliciesList | *No description.* | +| EnvironmentInput | string | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Environment | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Policies`Required + +```csharp +public DataGithubRepositoryEnvironmentDeploymentPoliciesPoliciesList Policies { get; } +``` + +- *Type:* DataGithubRepositoryEnvironmentDeploymentPoliciesPoliciesList + +--- + +##### `EnvironmentInput`Optional + +```csharp +public string EnvironmentInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Environment`Required + +```csharp +public string Environment { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubRepositoryEnvironmentDeploymentPoliciesConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryEnvironmentDeploymentPoliciesConfig { + 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 Environment, + string Repository, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Environment | string | The name of the environment. | +| Repository | string | The name of the GitHub repository. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environment_deployment_policies#id DataGithubRepositoryEnvironmentDeploymentPolicies#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Environment`Required + +```csharp +public string Environment { get; set; } +``` + +- *Type:* string + +The name of the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environment_deployment_policies#environment DataGithubRepositoryEnvironmentDeploymentPolicies#environment} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The name of the GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environment_deployment_policies#repository DataGithubRepositoryEnvironmentDeploymentPolicies#repository} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environment_deployment_policies#id DataGithubRepositoryEnvironmentDeploymentPolicies#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. + +--- + +### DataGithubRepositoryEnvironmentDeploymentPoliciesPolicies + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryEnvironmentDeploymentPoliciesPolicies { + +}; +``` + + +## Classes + +### DataGithubRepositoryEnvironmentDeploymentPoliciesPoliciesList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryEnvironmentDeploymentPoliciesPoliciesList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubRepositoryEnvironmentDeploymentPoliciesPoliciesOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubRepositoryEnvironmentDeploymentPoliciesPoliciesOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryEnvironmentDeploymentPoliciesPoliciesOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Pattern | string | *No description.* | +| Type | string | *No description.* | +| InternalValue | DataGithubRepositoryEnvironmentDeploymentPoliciesPolicies | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; } +``` + +- *Type:* string + +--- + +##### `Type`Required + +```csharp +public string Type { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubRepositoryEnvironmentDeploymentPoliciesPolicies InternalValue { get; } +``` + +- *Type:* DataGithubRepositoryEnvironmentDeploymentPoliciesPolicies + +--- + + + diff --git a/docs/dataGithubRepositoryEnvironmentDeploymentPolicies.java.md b/docs/dataGithubRepositoryEnvironmentDeploymentPolicies.java.md new file mode 100644 index 000000000..30e6789da --- /dev/null +++ b/docs/dataGithubRepositoryEnvironmentDeploymentPolicies.java.md @@ -0,0 +1,1337 @@ +# `dataGithubRepositoryEnvironmentDeploymentPolicies` Submodule + +## Constructs + +### DataGithubRepositoryEnvironmentDeploymentPolicies + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environment_deployment_policies github_repository_environment_deployment_policies}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_environment_deployment_policies.DataGithubRepositoryEnvironmentDeploymentPolicies; + +DataGithubRepositoryEnvironmentDeploymentPolicies.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .environment(java.lang.String) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| environment | java.lang.String | The name of the environment. | +| repository | java.lang.String | The name of the GitHub repository. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environment_deployment_policies#id DataGithubRepositoryEnvironmentDeploymentPolicies#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `environment`Required + +- *Type:* java.lang.String + +The name of the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environment_deployment_policies#environment DataGithubRepositoryEnvironmentDeploymentPolicies#environment} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The name of the GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environment_deployment_policies#repository DataGithubRepositoryEnvironmentDeploymentPolicies#repository} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environment_deployment_policies#id DataGithubRepositoryEnvironmentDeploymentPolicies#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryEnvironmentDeploymentPolicies resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_repository_environment_deployment_policies.DataGithubRepositoryEnvironmentDeploymentPolicies; + +DataGithubRepositoryEnvironmentDeploymentPolicies.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` + +```java +import io.cdktn.providers.github.data_github_repository_environment_deployment_policies.DataGithubRepositoryEnvironmentDeploymentPolicies; + +DataGithubRepositoryEnvironmentDeploymentPolicies.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_repository_environment_deployment_policies.DataGithubRepositoryEnvironmentDeploymentPolicies; + +DataGithubRepositoryEnvironmentDeploymentPolicies.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_repository_environment_deployment_policies.DataGithubRepositoryEnvironmentDeploymentPolicies; + +DataGithubRepositoryEnvironmentDeploymentPolicies.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubRepositoryEnvironmentDeploymentPolicies.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubRepositoryEnvironmentDeploymentPolicies 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 DataGithubRepositoryEnvironmentDeploymentPolicies to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubRepositoryEnvironmentDeploymentPolicies that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environment_deployment_policies#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 DataGithubRepositoryEnvironmentDeploymentPolicies 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| policies | DataGithubRepositoryEnvironmentDeploymentPoliciesPoliciesList | *No description.* | +| environmentInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| environment | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `policies`Required + +```java +public DataGithubRepositoryEnvironmentDeploymentPoliciesPoliciesList getPolicies(); +``` + +- *Type:* DataGithubRepositoryEnvironmentDeploymentPoliciesPoliciesList + +--- + +##### `environmentInput`Optional + +```java +public java.lang.String getEnvironmentInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `environment`Required + +```java +public java.lang.String getEnvironment(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubRepositoryEnvironmentDeploymentPoliciesConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_environment_deployment_policies.DataGithubRepositoryEnvironmentDeploymentPoliciesConfig; + +DataGithubRepositoryEnvironmentDeploymentPoliciesConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .environment(java.lang.String) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| environment | java.lang.String | The name of the environment. | +| repository | java.lang.String | The name of the GitHub repository. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environment_deployment_policies#id DataGithubRepositoryEnvironmentDeploymentPolicies#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `environment`Required + +```java +public java.lang.String getEnvironment(); +``` + +- *Type:* java.lang.String + +The name of the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environment_deployment_policies#environment DataGithubRepositoryEnvironmentDeploymentPolicies#environment} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The name of the GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environment_deployment_policies#repository DataGithubRepositoryEnvironmentDeploymentPolicies#repository} + +--- + +##### `id`Optional + +```java +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/repository_environment_deployment_policies#id DataGithubRepositoryEnvironmentDeploymentPolicies#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. + +--- + +### DataGithubRepositoryEnvironmentDeploymentPoliciesPolicies + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_environment_deployment_policies.DataGithubRepositoryEnvironmentDeploymentPoliciesPolicies; + +DataGithubRepositoryEnvironmentDeploymentPoliciesPolicies.builder() + .build(); +``` + + +## Classes + +### DataGithubRepositoryEnvironmentDeploymentPoliciesPoliciesList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_environment_deployment_policies.DataGithubRepositoryEnvironmentDeploymentPoliciesPoliciesList; + +new DataGithubRepositoryEnvironmentDeploymentPoliciesPoliciesList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubRepositoryEnvironmentDeploymentPoliciesPoliciesOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubRepositoryEnvironmentDeploymentPoliciesPoliciesOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_environment_deployment_policies.DataGithubRepositoryEnvironmentDeploymentPoliciesPoliciesOutputReference; + +new DataGithubRepositoryEnvironmentDeploymentPoliciesPoliciesOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| pattern | java.lang.String | *No description.* | +| type | java.lang.String | *No description.* | +| internalValue | DataGithubRepositoryEnvironmentDeploymentPoliciesPolicies | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +--- + +##### `type`Required + +```java +public java.lang.String getType(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubRepositoryEnvironmentDeploymentPoliciesPolicies getInternalValue(); +``` + +- *Type:* DataGithubRepositoryEnvironmentDeploymentPoliciesPolicies + +--- + + + diff --git a/docs/dataGithubRepositoryEnvironments.csharp.md b/docs/dataGithubRepositoryEnvironments.csharp.md new file mode 100644 index 000000000..774e4c4bf --- /dev/null +++ b/docs/dataGithubRepositoryEnvironments.csharp.md @@ -0,0 +1,1211 @@ +# `dataGithubRepositoryEnvironments` Submodule + +## Constructs + +### DataGithubRepositoryEnvironments + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environments github_repository_environments}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryEnvironments(Construct Scope, string Id, DataGithubRepositoryEnvironmentsConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubRepositoryEnvironmentsConfig | *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:* DataGithubRepositoryEnvironmentsConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryEnvironments resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryEnvironments.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryEnvironments.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryEnvironments.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryEnvironments.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubRepositoryEnvironments resource upon running "cdktn 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 DataGithubRepositoryEnvironments to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubRepositoryEnvironments that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environments#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubRepositoryEnvironments to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Environments | DataGithubRepositoryEnvironmentsEnvironmentsList | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Environments`Required + +```csharp +public DataGithubRepositoryEnvironmentsEnvironmentsList Environments { get; } +``` + +- *Type:* DataGithubRepositoryEnvironmentsEnvironmentsList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubRepositoryEnvironmentsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryEnvironmentsConfig { + 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 Repository, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environments#repository DataGithubRepositoryEnvironments#repository}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environments#id DataGithubRepositoryEnvironments#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environments#repository DataGithubRepositoryEnvironments#repository}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environments#id DataGithubRepositoryEnvironments#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. + +--- + +### DataGithubRepositoryEnvironmentsEnvironments + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryEnvironmentsEnvironments { + +}; +``` + + +## Classes + +### DataGithubRepositoryEnvironmentsEnvironmentsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryEnvironmentsEnvironmentsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubRepositoryEnvironmentsEnvironmentsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubRepositoryEnvironmentsEnvironmentsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryEnvironmentsEnvironmentsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Name | string | *No description.* | +| NodeId | string | *No description.* | +| InternalValue | DataGithubRepositoryEnvironmentsEnvironments | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `NodeId`Required + +```csharp +public string NodeId { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubRepositoryEnvironmentsEnvironments InternalValue { get; } +``` + +- *Type:* DataGithubRepositoryEnvironmentsEnvironments + +--- + + + diff --git a/docs/dataGithubRepositoryEnvironments.java.md b/docs/dataGithubRepositoryEnvironments.java.md new file mode 100644 index 000000000..cbffab04f --- /dev/null +++ b/docs/dataGithubRepositoryEnvironments.java.md @@ -0,0 +1,1283 @@ +# `dataGithubRepositoryEnvironments` Submodule + +## Constructs + +### DataGithubRepositoryEnvironments + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environments github_repository_environments}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_environments.DataGithubRepositoryEnvironments; + +DataGithubRepositoryEnvironments.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environments#repository DataGithubRepositoryEnvironments#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environments#id DataGithubRepositoryEnvironments#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environments#repository DataGithubRepositoryEnvironments#repository}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environments#id DataGithubRepositoryEnvironments#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryEnvironments resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_repository_environments.DataGithubRepositoryEnvironments; + +DataGithubRepositoryEnvironments.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` + +```java +import io.cdktn.providers.github.data_github_repository_environments.DataGithubRepositoryEnvironments; + +DataGithubRepositoryEnvironments.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_repository_environments.DataGithubRepositoryEnvironments; + +DataGithubRepositoryEnvironments.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_repository_environments.DataGithubRepositoryEnvironments; + +DataGithubRepositoryEnvironments.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubRepositoryEnvironments.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubRepositoryEnvironments 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 DataGithubRepositoryEnvironments to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubRepositoryEnvironments that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environments#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 DataGithubRepositoryEnvironments 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| environments | DataGithubRepositoryEnvironmentsEnvironmentsList | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `environments`Required + +```java +public DataGithubRepositoryEnvironmentsEnvironmentsList getEnvironments(); +``` + +- *Type:* DataGithubRepositoryEnvironmentsEnvironmentsList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubRepositoryEnvironmentsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_environments.DataGithubRepositoryEnvironmentsConfig; + +DataGithubRepositoryEnvironmentsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environments#repository DataGithubRepositoryEnvironments#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environments#id DataGithubRepositoryEnvironments#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_environments#repository DataGithubRepositoryEnvironments#repository}. + +--- + +##### `id`Optional + +```java +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/repository_environments#id DataGithubRepositoryEnvironments#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. + +--- + +### DataGithubRepositoryEnvironmentsEnvironments + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_environments.DataGithubRepositoryEnvironmentsEnvironments; + +DataGithubRepositoryEnvironmentsEnvironments.builder() + .build(); +``` + + +## Classes + +### DataGithubRepositoryEnvironmentsEnvironmentsList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_environments.DataGithubRepositoryEnvironmentsEnvironmentsList; + +new DataGithubRepositoryEnvironmentsEnvironmentsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubRepositoryEnvironmentsEnvironmentsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubRepositoryEnvironmentsEnvironmentsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_environments.DataGithubRepositoryEnvironmentsEnvironmentsOutputReference; + +new DataGithubRepositoryEnvironmentsEnvironmentsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| nodeId | java.lang.String | *No description.* | +| internalValue | DataGithubRepositoryEnvironmentsEnvironments | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `nodeId`Required + +```java +public java.lang.String getNodeId(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubRepositoryEnvironmentsEnvironments getInternalValue(); +``` + +- *Type:* DataGithubRepositoryEnvironmentsEnvironments + +--- + + + diff --git a/docs/dataGithubRepositoryFile.csharp.md b/docs/dataGithubRepositoryFile.csharp.md new file mode 100644 index 000000000..d4ca268fa --- /dev/null +++ b/docs/dataGithubRepositoryFile.csharp.md @@ -0,0 +1,910 @@ +# `dataGithubRepositoryFile` Submodule + +## Constructs + +### DataGithubRepositoryFile + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_file github_repository_file}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryFile(Construct Scope, string Id, DataGithubRepositoryFileConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubRepositoryFileConfig | *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:* DataGithubRepositoryFileConfig + +--- + +#### 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.* | +| ResetBranch | *No description.* | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetBranch` + +```csharp +private void ResetBranch() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryFile resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryFile.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryFile.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryFile.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryFile.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubRepositoryFile resource upon running "cdktn 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 DataGithubRepositoryFile to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubRepositoryFile that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_file#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubRepositoryFile to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| CommitAuthor | string | *No description.* | +| CommitEmail | string | *No description.* | +| CommitMessage | string | *No description.* | +| CommitSha | string | *No description.* | +| Content | string | *No description.* | +| Ref | string | *No description.* | +| Sha | string | *No description.* | +| BranchInput | string | *No description.* | +| FileInput | string | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Branch | string | *No description.* | +| File | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `CommitAuthor`Required + +```csharp +public string CommitAuthor { get; } +``` + +- *Type:* string + +--- + +##### `CommitEmail`Required + +```csharp +public string CommitEmail { get; } +``` + +- *Type:* string + +--- + +##### `CommitMessage`Required + +```csharp +public string CommitMessage { get; } +``` + +- *Type:* string + +--- + +##### `CommitSha`Required + +```csharp +public string CommitSha { get; } +``` + +- *Type:* string + +--- + +##### `Content`Required + +```csharp +public string Content { get; } +``` + +- *Type:* string + +--- + +##### `Ref`Required + +```csharp +public string Ref { get; } +``` + +- *Type:* string + +--- + +##### `Sha`Required + +```csharp +public string Sha { get; } +``` + +- *Type:* string + +--- + +##### `BranchInput`Optional + +```csharp +public string BranchInput { get; } +``` + +- *Type:* string + +--- + +##### `FileInput`Optional + +```csharp +public string FileInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Branch`Required + +```csharp +public string Branch { get; } +``` + +- *Type:* string + +--- + +##### `File`Required + +```csharp +public string File { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubRepositoryFileConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryFileConfig { + 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 File, + string Repository, + string Branch = null, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| File | string | The file path to manage. | +| Repository | string | The repository name. | +| Branch | string | The branch name, defaults to the repository's default branch. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_file#id DataGithubRepositoryFile#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `File`Required + +```csharp +public string File { get; set; } +``` + +- *Type:* string + +The file path to manage. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_file#file DataGithubRepositoryFile#file} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_file#repository DataGithubRepositoryFile#repository} + +--- + +##### `Branch`Optional + +```csharp +public string Branch { get; set; } +``` + +- *Type:* string + +The branch name, defaults to the repository's default branch. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_file#branch DataGithubRepositoryFile#branch} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_file#id DataGithubRepositoryFile#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. + +--- + + + diff --git a/docs/dataGithubRepositoryFile.java.md b/docs/dataGithubRepositoryFile.java.md new file mode 100644 index 000000000..41122a95c --- /dev/null +++ b/docs/dataGithubRepositoryFile.java.md @@ -0,0 +1,1009 @@ +# `dataGithubRepositoryFile` Submodule + +## Constructs + +### DataGithubRepositoryFile + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_file github_repository_file}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_file.DataGithubRepositoryFile; + +DataGithubRepositoryFile.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .file(java.lang.String) + .repository(java.lang.String) +// .branch(java.lang.String) +// .id(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 | *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 | *No description.* | +| file | java.lang.String | The file path to manage. | +| repository | java.lang.String | The repository name. | +| branch | java.lang.String | The branch name, defaults to the repository's default branch. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_file#id DataGithubRepositoryFile#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `file`Required + +- *Type:* java.lang.String + +The file path to manage. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_file#file DataGithubRepositoryFile#file} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_file#repository DataGithubRepositoryFile#repository} + +--- + +##### `branch`Optional + +- *Type:* java.lang.String + +The branch name, defaults to the repository's default branch. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_file#branch DataGithubRepositoryFile#branch} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_file#id DataGithubRepositoryFile#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. + +--- + +#### 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.* | +| resetBranch | *No description.* | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetBranch` + +```java +public void resetBranch() +``` + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryFile resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_repository_file.DataGithubRepositoryFile; + +DataGithubRepositoryFile.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` + +```java +import io.cdktn.providers.github.data_github_repository_file.DataGithubRepositoryFile; + +DataGithubRepositoryFile.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_repository_file.DataGithubRepositoryFile; + +DataGithubRepositoryFile.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_repository_file.DataGithubRepositoryFile; + +DataGithubRepositoryFile.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubRepositoryFile.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubRepositoryFile 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 DataGithubRepositoryFile to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubRepositoryFile that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_file#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 DataGithubRepositoryFile 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| commitAuthor | java.lang.String | *No description.* | +| commitEmail | java.lang.String | *No description.* | +| commitMessage | java.lang.String | *No description.* | +| commitSha | java.lang.String | *No description.* | +| content | java.lang.String | *No description.* | +| ref | java.lang.String | *No description.* | +| sha | java.lang.String | *No description.* | +| branchInput | java.lang.String | *No description.* | +| fileInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| branch | java.lang.String | *No description.* | +| file | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `commitAuthor`Required + +```java +public java.lang.String getCommitAuthor(); +``` + +- *Type:* java.lang.String + +--- + +##### `commitEmail`Required + +```java +public java.lang.String getCommitEmail(); +``` + +- *Type:* java.lang.String + +--- + +##### `commitMessage`Required + +```java +public java.lang.String getCommitMessage(); +``` + +- *Type:* java.lang.String + +--- + +##### `commitSha`Required + +```java +public java.lang.String getCommitSha(); +``` + +- *Type:* java.lang.String + +--- + +##### `content`Required + +```java +public java.lang.String getContent(); +``` + +- *Type:* java.lang.String + +--- + +##### `ref`Required + +```java +public java.lang.String getRef(); +``` + +- *Type:* java.lang.String + +--- + +##### `sha`Required + +```java +public java.lang.String getSha(); +``` + +- *Type:* java.lang.String + +--- + +##### `branchInput`Optional + +```java +public java.lang.String getBranchInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `fileInput`Optional + +```java +public java.lang.String getFileInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `branch`Required + +```java +public java.lang.String getBranch(); +``` + +- *Type:* java.lang.String + +--- + +##### `file`Required + +```java +public java.lang.String getFile(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubRepositoryFileConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_file.DataGithubRepositoryFileConfig; + +DataGithubRepositoryFileConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .file(java.lang.String) + .repository(java.lang.String) +// .branch(java.lang.String) +// .id(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 | *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 | *No description.* | +| file | java.lang.String | The file path to manage. | +| repository | java.lang.String | The repository name. | +| branch | java.lang.String | The branch name, defaults to the repository's default branch. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_file#id DataGithubRepositoryFile#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `file`Required + +```java +public java.lang.String getFile(); +``` + +- *Type:* java.lang.String + +The file path to manage. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_file#file DataGithubRepositoryFile#file} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_file#repository DataGithubRepositoryFile#repository} + +--- + +##### `branch`Optional + +```java +public java.lang.String getBranch(); +``` + +- *Type:* java.lang.String + +The branch name, defaults to the repository's default branch. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_file#branch DataGithubRepositoryFile#branch} + +--- + +##### `id`Optional + +```java +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/repository_file#id DataGithubRepositoryFile#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. + +--- + + + diff --git a/docs/dataGithubRepositoryMilestone.csharp.md b/docs/dataGithubRepositoryMilestone.csharp.md new file mode 100644 index 000000000..af00559a2 --- /dev/null +++ b/docs/dataGithubRepositoryMilestone.csharp.md @@ -0,0 +1,864 @@ +# `dataGithubRepositoryMilestone` Submodule + +## Constructs + +### DataGithubRepositoryMilestone + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone github_repository_milestone}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryMilestone(Construct Scope, string Id, DataGithubRepositoryMilestoneConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubRepositoryMilestoneConfig | *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:* DataGithubRepositoryMilestoneConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryMilestone resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryMilestone.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryMilestone.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryMilestone.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryMilestone.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubRepositoryMilestone resource upon running "cdktn 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 DataGithubRepositoryMilestone to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubRepositoryMilestone that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubRepositoryMilestone to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Description | string | *No description.* | +| DueDate | string | *No description.* | +| State | string | *No description.* | +| Title | string | *No description.* | +| IdInput | string | *No description.* | +| NumberInput | double | *No description.* | +| OwnerInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Id | string | *No description.* | +| Number | double | *No description.* | +| Owner | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `DueDate`Required + +```csharp +public string DueDate { get; } +``` + +- *Type:* string + +--- + +##### `State`Required + +```csharp +public string State { get; } +``` + +- *Type:* string + +--- + +##### `Title`Required + +```csharp +public string Title { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NumberInput`Optional + +```csharp +public double NumberInput { get; } +``` + +- *Type:* double + +--- + +##### `OwnerInput`Optional + +```csharp +public string OwnerInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Number`Required + +```csharp +public double Number { get; } +``` + +- *Type:* double + +--- + +##### `Owner`Required + +```csharp +public string Owner { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubRepositoryMilestoneConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryMilestoneConfig { + 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, + double Number, + string Owner, + string Repository, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Number | double | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#number DataGithubRepositoryMilestone#number}. | +| Owner | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#owner DataGithubRepositoryMilestone#owner}. | +| Repository | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#repository DataGithubRepositoryMilestone#repository}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#id DataGithubRepositoryMilestone#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Number`Required + +```csharp +public double Number { get; set; } +``` + +- *Type:* double + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#number DataGithubRepositoryMilestone#number}. + +--- + +##### `Owner`Required + +```csharp +public string Owner { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#owner DataGithubRepositoryMilestone#owner}. + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#repository DataGithubRepositoryMilestone#repository}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#id DataGithubRepositoryMilestone#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. + +--- + + + diff --git a/docs/dataGithubRepositoryMilestone.java.md b/docs/dataGithubRepositoryMilestone.java.md new file mode 100644 index 000000000..3fb398fb8 --- /dev/null +++ b/docs/dataGithubRepositoryMilestone.java.md @@ -0,0 +1,957 @@ +# `dataGithubRepositoryMilestone` Submodule + +## Constructs + +### DataGithubRepositoryMilestone + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone github_repository_milestone}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_milestone.DataGithubRepositoryMilestone; + +DataGithubRepositoryMilestone.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .number(java.lang.Number) + .owner(java.lang.String) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| number | java.lang.Number | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#number DataGithubRepositoryMilestone#number}. | +| owner | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#owner DataGithubRepositoryMilestone#owner}. | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#repository DataGithubRepositoryMilestone#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#id DataGithubRepositoryMilestone#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `number`Required + +- *Type:* java.lang.Number + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#number DataGithubRepositoryMilestone#number}. + +--- + +##### `owner`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#owner DataGithubRepositoryMilestone#owner}. + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#repository DataGithubRepositoryMilestone#repository}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#id DataGithubRepositoryMilestone#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryMilestone resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_repository_milestone.DataGithubRepositoryMilestone; + +DataGithubRepositoryMilestone.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` + +```java +import io.cdktn.providers.github.data_github_repository_milestone.DataGithubRepositoryMilestone; + +DataGithubRepositoryMilestone.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_repository_milestone.DataGithubRepositoryMilestone; + +DataGithubRepositoryMilestone.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_repository_milestone.DataGithubRepositoryMilestone; + +DataGithubRepositoryMilestone.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubRepositoryMilestone.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubRepositoryMilestone 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 DataGithubRepositoryMilestone to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubRepositoryMilestone that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#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 DataGithubRepositoryMilestone 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| description | java.lang.String | *No description.* | +| dueDate | java.lang.String | *No description.* | +| state | java.lang.String | *No description.* | +| title | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| numberInput | java.lang.Number | *No description.* | +| ownerInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| number | java.lang.Number | *No description.* | +| owner | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `dueDate`Required + +```java +public java.lang.String getDueDate(); +``` + +- *Type:* java.lang.String + +--- + +##### `state`Required + +```java +public java.lang.String getState(); +``` + +- *Type:* java.lang.String + +--- + +##### `title`Required + +```java +public java.lang.String getTitle(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `numberInput`Optional + +```java +public java.lang.Number getNumberInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `ownerInput`Optional + +```java +public java.lang.String getOwnerInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `number`Required + +```java +public java.lang.Number getNumber(); +``` + +- *Type:* java.lang.Number + +--- + +##### `owner`Required + +```java +public java.lang.String getOwner(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubRepositoryMilestoneConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_milestone.DataGithubRepositoryMilestoneConfig; + +DataGithubRepositoryMilestoneConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .number(java.lang.Number) + .owner(java.lang.String) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| number | java.lang.Number | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#number DataGithubRepositoryMilestone#number}. | +| owner | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#owner DataGithubRepositoryMilestone#owner}. | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#repository DataGithubRepositoryMilestone#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#id DataGithubRepositoryMilestone#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `number`Required + +```java +public java.lang.Number getNumber(); +``` + +- *Type:* java.lang.Number + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#number DataGithubRepositoryMilestone#number}. + +--- + +##### `owner`Required + +```java +public java.lang.String getOwner(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#owner DataGithubRepositoryMilestone#owner}. + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_milestone#repository DataGithubRepositoryMilestone#repository}. + +--- + +##### `id`Optional + +```java +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/repository_milestone#id DataGithubRepositoryMilestone#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. + +--- + + + diff --git a/docs/dataGithubRepositoryPages.csharp.md b/docs/dataGithubRepositoryPages.csharp.md new file mode 100644 index 000000000..afc6d470e --- /dev/null +++ b/docs/dataGithubRepositoryPages.csharp.md @@ -0,0 +1,1301 @@ +# `dataGithubRepositoryPages` Submodule + +## Constructs + +### DataGithubRepositoryPagesA + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pages github_repository_pages}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryPagesA(Construct Scope, string Id, DataGithubRepositoryPagesAConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubRepositoryPagesAConfig | *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:* DataGithubRepositoryPagesAConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryPagesA resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryPagesA.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryPagesA.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryPagesA.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryPagesA.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubRepositoryPagesA resource upon running "cdktn 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 DataGithubRepositoryPagesA to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubRepositoryPagesA that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pages#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubRepositoryPagesA to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| ApiUrl | string | *No description.* | +| BuildStatus | string | *No description.* | +| BuildType | string | *No description.* | +| Cname | string | *No description.* | +| Custom404 | Io.Cdktn.IResolvable | *No description.* | +| HtmlUrl | string | *No description.* | +| HttpsEnforced | Io.Cdktn.IResolvable | *No description.* | +| Public | Io.Cdktn.IResolvable | *No description.* | +| Source | DataGithubRepositoryPagesSourceAList | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `ApiUrl`Required + +```csharp +public string ApiUrl { get; } +``` + +- *Type:* string + +--- + +##### `BuildStatus`Required + +```csharp +public string BuildStatus { get; } +``` + +- *Type:* string + +--- + +##### `BuildType`Required + +```csharp +public string BuildType { get; } +``` + +- *Type:* string + +--- + +##### `Cname`Required + +```csharp +public string Cname { get; } +``` + +- *Type:* string + +--- + +##### `Custom404`Required + +```csharp +public IResolvable Custom404 { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `HtmlUrl`Required + +```csharp +public string HtmlUrl { get; } +``` + +- *Type:* string + +--- + +##### `HttpsEnforced`Required + +```csharp +public IResolvable HttpsEnforced { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `Public`Required + +```csharp +public IResolvable Public { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `Source`Required + +```csharp +public DataGithubRepositoryPagesSourceAList Source { get; } +``` + +- *Type:* DataGithubRepositoryPagesSourceAList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubRepositoryPagesAConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryPagesAConfig { + 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 Repository, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | The repository name to get GitHub Pages information for. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pages#id DataGithubRepositoryPagesA#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The repository name to get GitHub Pages information for. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pages#repository DataGithubRepositoryPagesA#repository} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pages#id DataGithubRepositoryPagesA#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. + +--- + +### DataGithubRepositoryPagesSourceA + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryPagesSourceA { + +}; +``` + + +## Classes + +### DataGithubRepositoryPagesSourceAList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryPagesSourceAList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubRepositoryPagesSourceAOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubRepositoryPagesSourceAOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryPagesSourceAOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Branch | string | *No description.* | +| Path | string | *No description.* | +| InternalValue | DataGithubRepositoryPagesSourceA | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Branch`Required + +```csharp +public string Branch { get; } +``` + +- *Type:* string + +--- + +##### `Path`Required + +```csharp +public string Path { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubRepositoryPagesSourceA InternalValue { get; } +``` + +- *Type:* DataGithubRepositoryPagesSourceA + +--- + + + diff --git a/docs/dataGithubRepositoryPages.java.md b/docs/dataGithubRepositoryPages.java.md new file mode 100644 index 000000000..193b14db0 --- /dev/null +++ b/docs/dataGithubRepositoryPages.java.md @@ -0,0 +1,1375 @@ +# `dataGithubRepositoryPages` Submodule + +## Constructs + +### DataGithubRepositoryPagesA + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pages github_repository_pages}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_pages.DataGithubRepositoryPagesA; + +DataGithubRepositoryPagesA.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | The repository name to get GitHub Pages information for. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pages#id DataGithubRepositoryPagesA#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The repository name to get GitHub Pages information for. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pages#repository DataGithubRepositoryPagesA#repository} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pages#id DataGithubRepositoryPagesA#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryPagesA resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_repository_pages.DataGithubRepositoryPagesA; + +DataGithubRepositoryPagesA.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` + +```java +import io.cdktn.providers.github.data_github_repository_pages.DataGithubRepositoryPagesA; + +DataGithubRepositoryPagesA.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_repository_pages.DataGithubRepositoryPagesA; + +DataGithubRepositoryPagesA.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_repository_pages.DataGithubRepositoryPagesA; + +DataGithubRepositoryPagesA.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubRepositoryPagesA.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubRepositoryPagesA 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 DataGithubRepositoryPagesA to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubRepositoryPagesA that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pages#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 DataGithubRepositoryPagesA 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| apiUrl | java.lang.String | *No description.* | +| buildStatus | java.lang.String | *No description.* | +| buildType | java.lang.String | *No description.* | +| cname | java.lang.String | *No description.* | +| custom404 | io.cdktn.cdktn.IResolvable | *No description.* | +| htmlUrl | java.lang.String | *No description.* | +| httpsEnforced | io.cdktn.cdktn.IResolvable | *No description.* | +| public | io.cdktn.cdktn.IResolvable | *No description.* | +| source | DataGithubRepositoryPagesSourceAList | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `apiUrl`Required + +```java +public java.lang.String getApiUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `buildStatus`Required + +```java +public java.lang.String getBuildStatus(); +``` + +- *Type:* java.lang.String + +--- + +##### `buildType`Required + +```java +public java.lang.String getBuildType(); +``` + +- *Type:* java.lang.String + +--- + +##### `cname`Required + +```java +public java.lang.String getCname(); +``` + +- *Type:* java.lang.String + +--- + +##### `custom404`Required + +```java +public IResolvable getCustom404(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `htmlUrl`Required + +```java +public java.lang.String getHtmlUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `httpsEnforced`Required + +```java +public IResolvable getHttpsEnforced(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `public`Required + +```java +public IResolvable getPublic(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `source`Required + +```java +public DataGithubRepositoryPagesSourceAList getSource(); +``` + +- *Type:* DataGithubRepositoryPagesSourceAList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubRepositoryPagesAConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_pages.DataGithubRepositoryPagesAConfig; + +DataGithubRepositoryPagesAConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | The repository name to get GitHub Pages information for. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pages#id DataGithubRepositoryPagesA#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The repository name to get GitHub Pages information for. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pages#repository DataGithubRepositoryPagesA#repository} + +--- + +##### `id`Optional + +```java +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/repository_pages#id DataGithubRepositoryPagesA#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. + +--- + +### DataGithubRepositoryPagesSourceA + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_pages.DataGithubRepositoryPagesSourceA; + +DataGithubRepositoryPagesSourceA.builder() + .build(); +``` + + +## Classes + +### DataGithubRepositoryPagesSourceAList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_pages.DataGithubRepositoryPagesSourceAList; + +new DataGithubRepositoryPagesSourceAList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubRepositoryPagesSourceAOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubRepositoryPagesSourceAOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_pages.DataGithubRepositoryPagesSourceAOutputReference; + +new DataGithubRepositoryPagesSourceAOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| branch | java.lang.String | *No description.* | +| path | java.lang.String | *No description.* | +| internalValue | DataGithubRepositoryPagesSourceA | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `branch`Required + +```java +public java.lang.String getBranch(); +``` + +- *Type:* java.lang.String + +--- + +##### `path`Required + +```java +public java.lang.String getPath(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubRepositoryPagesSourceA getInternalValue(); +``` + +- *Type:* DataGithubRepositoryPagesSourceA + +--- + + + diff --git a/docs/dataGithubRepositoryPullRequest.csharp.md b/docs/dataGithubRepositoryPullRequest.csharp.md new file mode 100644 index 000000000..3a9bfd5be --- /dev/null +++ b/docs/dataGithubRepositoryPullRequest.csharp.md @@ -0,0 +1,992 @@ +# `dataGithubRepositoryPullRequest` Submodule + +## Constructs + +### DataGithubRepositoryPullRequest + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request github_repository_pull_request}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryPullRequest(Construct Scope, string Id, DataGithubRepositoryPullRequestConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubRepositoryPullRequestConfig | *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:* DataGithubRepositoryPullRequestConfig + +--- + +#### 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.* | +| ResetOwner | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetOwner` + +```csharp +private void ResetOwner() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryPullRequest resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryPullRequest.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryPullRequest.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryPullRequest.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryPullRequest.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubRepositoryPullRequest resource upon running "cdktn 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 DataGithubRepositoryPullRequest to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubRepositoryPullRequest that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubRepositoryPullRequest to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| BaseRef | string | *No description.* | +| BaseSha | string | *No description.* | +| Body | string | *No description.* | +| Draft | Io.Cdktn.IResolvable | *No description.* | +| HeadOwner | string | *No description.* | +| HeadRef | string | *No description.* | +| HeadRepository | string | *No description.* | +| HeadSha | string | *No description.* | +| Labels | string[] | *No description.* | +| MaintainerCanModify | Io.Cdktn.IResolvable | *No description.* | +| OpenedAt | double | *No description.* | +| OpenedBy | string | *No description.* | +| State | string | *No description.* | +| Title | string | *No description.* | +| UpdatedAt | double | *No description.* | +| BaseRepositoryInput | string | *No description.* | +| IdInput | string | *No description.* | +| NumberInput | double | *No description.* | +| OwnerInput | string | *No description.* | +| BaseRepository | string | *No description.* | +| Id | string | *No description.* | +| Number | double | *No description.* | +| Owner | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `BaseRef`Required + +```csharp +public string BaseRef { get; } +``` + +- *Type:* string + +--- + +##### `BaseSha`Required + +```csharp +public string BaseSha { get; } +``` + +- *Type:* string + +--- + +##### `Body`Required + +```csharp +public string Body { get; } +``` + +- *Type:* string + +--- + +##### `Draft`Required + +```csharp +public IResolvable Draft { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `HeadOwner`Required + +```csharp +public string HeadOwner { get; } +``` + +- *Type:* string + +--- + +##### `HeadRef`Required + +```csharp +public string HeadRef { get; } +``` + +- *Type:* string + +--- + +##### `HeadRepository`Required + +```csharp +public string HeadRepository { get; } +``` + +- *Type:* string + +--- + +##### `HeadSha`Required + +```csharp +public string HeadSha { get; } +``` + +- *Type:* string + +--- + +##### `Labels`Required + +```csharp +public string[] Labels { get; } +``` + +- *Type:* string[] + +--- + +##### `MaintainerCanModify`Required + +```csharp +public IResolvable MaintainerCanModify { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `OpenedAt`Required + +```csharp +public double OpenedAt { get; } +``` + +- *Type:* double + +--- + +##### `OpenedBy`Required + +```csharp +public string OpenedBy { get; } +``` + +- *Type:* string + +--- + +##### `State`Required + +```csharp +public string State { get; } +``` + +- *Type:* string + +--- + +##### `Title`Required + +```csharp +public string Title { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public double UpdatedAt { get; } +``` + +- *Type:* double + +--- + +##### `BaseRepositoryInput`Optional + +```csharp +public string BaseRepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NumberInput`Optional + +```csharp +public double NumberInput { get; } +``` + +- *Type:* double + +--- + +##### `OwnerInput`Optional + +```csharp +public string OwnerInput { get; } +``` + +- *Type:* string + +--- + +##### `BaseRepository`Required + +```csharp +public string BaseRepository { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Number`Required + +```csharp +public double Number { get; } +``` + +- *Type:* double + +--- + +##### `Owner`Required + +```csharp +public string Owner { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubRepositoryPullRequestConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryPullRequestConfig { + 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 BaseRepository, + double Number, + string Id = null, + string Owner = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| BaseRepository | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#base_repository DataGithubRepositoryPullRequest#base_repository}. | +| Number | double | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#number DataGithubRepositoryPullRequest#number}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#id DataGithubRepositoryPullRequest#id}. | +| Owner | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#owner DataGithubRepositoryPullRequest#owner}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `BaseRepository`Required + +```csharp +public string BaseRepository { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#base_repository DataGithubRepositoryPullRequest#base_repository}. + +--- + +##### `Number`Required + +```csharp +public double Number { get; set; } +``` + +- *Type:* double + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#number DataGithubRepositoryPullRequest#number}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#id DataGithubRepositoryPullRequest#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. + +--- + +##### `Owner`Optional + +```csharp +public string Owner { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#owner DataGithubRepositoryPullRequest#owner}. + +--- + + + diff --git a/docs/dataGithubRepositoryPullRequest.java.md b/docs/dataGithubRepositoryPullRequest.java.md new file mode 100644 index 000000000..1c6237ded --- /dev/null +++ b/docs/dataGithubRepositoryPullRequest.java.md @@ -0,0 +1,1085 @@ +# `dataGithubRepositoryPullRequest` Submodule + +## Constructs + +### DataGithubRepositoryPullRequest + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request github_repository_pull_request}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_pull_request.DataGithubRepositoryPullRequest; + +DataGithubRepositoryPullRequest.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .baseRepository(java.lang.String) + .number(java.lang.Number) +// .id(java.lang.String) +// .owner(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 | *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 | *No description.* | +| baseRepository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#base_repository DataGithubRepositoryPullRequest#base_repository}. | +| number | java.lang.Number | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#number DataGithubRepositoryPullRequest#number}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#id DataGithubRepositoryPullRequest#id}. | +| owner | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#owner DataGithubRepositoryPullRequest#owner}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `baseRepository`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#base_repository DataGithubRepositoryPullRequest#base_repository}. + +--- + +##### `number`Required + +- *Type:* java.lang.Number + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#number DataGithubRepositoryPullRequest#number}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#id DataGithubRepositoryPullRequest#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. + +--- + +##### `owner`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#owner DataGithubRepositoryPullRequest#owner}. + +--- + +#### 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.* | +| resetOwner | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetOwner` + +```java +public void resetOwner() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryPullRequest resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_repository_pull_request.DataGithubRepositoryPullRequest; + +DataGithubRepositoryPullRequest.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` + +```java +import io.cdktn.providers.github.data_github_repository_pull_request.DataGithubRepositoryPullRequest; + +DataGithubRepositoryPullRequest.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_repository_pull_request.DataGithubRepositoryPullRequest; + +DataGithubRepositoryPullRequest.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_repository_pull_request.DataGithubRepositoryPullRequest; + +DataGithubRepositoryPullRequest.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubRepositoryPullRequest.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubRepositoryPullRequest 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 DataGithubRepositoryPullRequest to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubRepositoryPullRequest that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#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 DataGithubRepositoryPullRequest 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| baseRef | java.lang.String | *No description.* | +| baseSha | java.lang.String | *No description.* | +| body | java.lang.String | *No description.* | +| draft | io.cdktn.cdktn.IResolvable | *No description.* | +| headOwner | java.lang.String | *No description.* | +| headRef | java.lang.String | *No description.* | +| headRepository | java.lang.String | *No description.* | +| headSha | java.lang.String | *No description.* | +| labels | java.util.List | *No description.* | +| maintainerCanModify | io.cdktn.cdktn.IResolvable | *No description.* | +| openedAt | java.lang.Number | *No description.* | +| openedBy | java.lang.String | *No description.* | +| state | java.lang.String | *No description.* | +| title | java.lang.String | *No description.* | +| updatedAt | java.lang.Number | *No description.* | +| baseRepositoryInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| numberInput | java.lang.Number | *No description.* | +| ownerInput | java.lang.String | *No description.* | +| baseRepository | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| number | java.lang.Number | *No description.* | +| owner | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `baseRef`Required + +```java +public java.lang.String getBaseRef(); +``` + +- *Type:* java.lang.String + +--- + +##### `baseSha`Required + +```java +public java.lang.String getBaseSha(); +``` + +- *Type:* java.lang.String + +--- + +##### `body`Required + +```java +public java.lang.String getBody(); +``` + +- *Type:* java.lang.String + +--- + +##### `draft`Required + +```java +public IResolvable getDraft(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `headOwner`Required + +```java +public java.lang.String getHeadOwner(); +``` + +- *Type:* java.lang.String + +--- + +##### `headRef`Required + +```java +public java.lang.String getHeadRef(); +``` + +- *Type:* java.lang.String + +--- + +##### `headRepository`Required + +```java +public java.lang.String getHeadRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `headSha`Required + +```java +public java.lang.String getHeadSha(); +``` + +- *Type:* java.lang.String + +--- + +##### `labels`Required + +```java +public java.util.List getLabels(); +``` + +- *Type:* java.util.List + +--- + +##### `maintainerCanModify`Required + +```java +public IResolvable getMaintainerCanModify(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `openedAt`Required + +```java +public java.lang.Number getOpenedAt(); +``` + +- *Type:* java.lang.Number + +--- + +##### `openedBy`Required + +```java +public java.lang.String getOpenedBy(); +``` + +- *Type:* java.lang.String + +--- + +##### `state`Required + +```java +public java.lang.String getState(); +``` + +- *Type:* java.lang.String + +--- + +##### `title`Required + +```java +public java.lang.String getTitle(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.Number getUpdatedAt(); +``` + +- *Type:* java.lang.Number + +--- + +##### `baseRepositoryInput`Optional + +```java +public java.lang.String getBaseRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `numberInput`Optional + +```java +public java.lang.Number getNumberInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `ownerInput`Optional + +```java +public java.lang.String getOwnerInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `baseRepository`Required + +```java +public java.lang.String getBaseRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `number`Required + +```java +public java.lang.Number getNumber(); +``` + +- *Type:* java.lang.Number + +--- + +##### `owner`Required + +```java +public java.lang.String getOwner(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubRepositoryPullRequestConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_pull_request.DataGithubRepositoryPullRequestConfig; + +DataGithubRepositoryPullRequestConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .baseRepository(java.lang.String) + .number(java.lang.Number) +// .id(java.lang.String) +// .owner(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 | *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 | *No description.* | +| baseRepository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#base_repository DataGithubRepositoryPullRequest#base_repository}. | +| number | java.lang.Number | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#number DataGithubRepositoryPullRequest#number}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#id DataGithubRepositoryPullRequest#id}. | +| owner | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#owner DataGithubRepositoryPullRequest#owner}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `baseRepository`Required + +```java +public java.lang.String getBaseRepository(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#base_repository DataGithubRepositoryPullRequest#base_repository}. + +--- + +##### `number`Required + +```java +public java.lang.Number getNumber(); +``` + +- *Type:* java.lang.Number + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#number DataGithubRepositoryPullRequest#number}. + +--- + +##### `id`Optional + +```java +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/repository_pull_request#id DataGithubRepositoryPullRequest#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. + +--- + +##### `owner`Optional + +```java +public java.lang.String getOwner(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_request#owner DataGithubRepositoryPullRequest#owner}. + +--- + + + diff --git a/docs/dataGithubRepositoryPullRequests.csharp.md b/docs/dataGithubRepositoryPullRequests.csharp.md new file mode 100644 index 000000000..fb2cc618f --- /dev/null +++ b/docs/dataGithubRepositoryPullRequests.csharp.md @@ -0,0 +1,1623 @@ +# `dataGithubRepositoryPullRequests` Submodule + +## Constructs + +### DataGithubRepositoryPullRequests + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests github_repository_pull_requests}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryPullRequests(Construct Scope, string Id, DataGithubRepositoryPullRequestsConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubRepositoryPullRequestsConfig | *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:* DataGithubRepositoryPullRequestsConfig + +--- + +#### 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.* | +| ResetBaseRef | *No description.* | +| ResetHeadRef | *No description.* | +| ResetId | *No description.* | +| ResetOwner | *No description.* | +| ResetSortBy | *No description.* | +| ResetSortDirection | *No description.* | +| ResetState | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetBaseRef` + +```csharp +private void ResetBaseRef() +``` + +##### `ResetHeadRef` + +```csharp +private void ResetHeadRef() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetOwner` + +```csharp +private void ResetOwner() +``` + +##### `ResetSortBy` + +```csharp +private void ResetSortBy() +``` + +##### `ResetSortDirection` + +```csharp +private void ResetSortDirection() +``` + +##### `ResetState` + +```csharp +private void ResetState() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryPullRequests resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryPullRequests.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryPullRequests.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryPullRequests.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryPullRequests.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubRepositoryPullRequests resource upon running "cdktn 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 DataGithubRepositoryPullRequests to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubRepositoryPullRequests that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubRepositoryPullRequests to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Results | DataGithubRepositoryPullRequestsResultsList | *No description.* | +| BaseRefInput | string | *No description.* | +| BaseRepositoryInput | string | *No description.* | +| HeadRefInput | string | *No description.* | +| IdInput | string | *No description.* | +| OwnerInput | string | *No description.* | +| SortByInput | string | *No description.* | +| SortDirectionInput | string | *No description.* | +| StateInput | string | *No description.* | +| BaseRef | string | *No description.* | +| BaseRepository | string | *No description.* | +| HeadRef | string | *No description.* | +| Id | string | *No description.* | +| Owner | string | *No description.* | +| SortBy | string | *No description.* | +| SortDirection | string | *No description.* | +| State | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Results`Required + +```csharp +public DataGithubRepositoryPullRequestsResultsList Results { get; } +``` + +- *Type:* DataGithubRepositoryPullRequestsResultsList + +--- + +##### `BaseRefInput`Optional + +```csharp +public string BaseRefInput { get; } +``` + +- *Type:* string + +--- + +##### `BaseRepositoryInput`Optional + +```csharp +public string BaseRepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `HeadRefInput`Optional + +```csharp +public string HeadRefInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `OwnerInput`Optional + +```csharp +public string OwnerInput { get; } +``` + +- *Type:* string + +--- + +##### `SortByInput`Optional + +```csharp +public string SortByInput { get; } +``` + +- *Type:* string + +--- + +##### `SortDirectionInput`Optional + +```csharp +public string SortDirectionInput { get; } +``` + +- *Type:* string + +--- + +##### `StateInput`Optional + +```csharp +public string StateInput { get; } +``` + +- *Type:* string + +--- + +##### `BaseRef`Required + +```csharp +public string BaseRef { get; } +``` + +- *Type:* string + +--- + +##### `BaseRepository`Required + +```csharp +public string BaseRepository { get; } +``` + +- *Type:* string + +--- + +##### `HeadRef`Required + +```csharp +public string HeadRef { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Owner`Required + +```csharp +public string Owner { get; } +``` + +- *Type:* string + +--- + +##### `SortBy`Required + +```csharp +public string SortBy { get; } +``` + +- *Type:* string + +--- + +##### `SortDirection`Required + +```csharp +public string SortDirection { get; } +``` + +- *Type:* string + +--- + +##### `State`Required + +```csharp +public string State { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubRepositoryPullRequestsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryPullRequestsConfig { + 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 BaseRepository, + string BaseRef = null, + string HeadRef = null, + string Id = null, + string Owner = null, + string SortBy = null, + string SortDirection = null, + string State = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| BaseRepository | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#base_repository DataGithubRepositoryPullRequests#base_repository}. | +| BaseRef | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#base_ref DataGithubRepositoryPullRequests#base_ref}. | +| HeadRef | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#head_ref DataGithubRepositoryPullRequests#head_ref}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#id DataGithubRepositoryPullRequests#id}. | +| Owner | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#owner DataGithubRepositoryPullRequests#owner}. | +| SortBy | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#sort_by DataGithubRepositoryPullRequests#sort_by}. | +| SortDirection | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#sort_direction DataGithubRepositoryPullRequests#sort_direction}. | +| State | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#state DataGithubRepositoryPullRequests#state}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `BaseRepository`Required + +```csharp +public string BaseRepository { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#base_repository DataGithubRepositoryPullRequests#base_repository}. + +--- + +##### `BaseRef`Optional + +```csharp +public string BaseRef { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#base_ref DataGithubRepositoryPullRequests#base_ref}. + +--- + +##### `HeadRef`Optional + +```csharp +public string HeadRef { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#head_ref DataGithubRepositoryPullRequests#head_ref}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#id DataGithubRepositoryPullRequests#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. + +--- + +##### `Owner`Optional + +```csharp +public string Owner { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#owner DataGithubRepositoryPullRequests#owner}. + +--- + +##### `SortBy`Optional + +```csharp +public string SortBy { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#sort_by DataGithubRepositoryPullRequests#sort_by}. + +--- + +##### `SortDirection`Optional + +```csharp +public string SortDirection { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#sort_direction DataGithubRepositoryPullRequests#sort_direction}. + +--- + +##### `State`Optional + +```csharp +public string State { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#state DataGithubRepositoryPullRequests#state}. + +--- + +### DataGithubRepositoryPullRequestsResults + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryPullRequestsResults { + +}; +``` + + +## Classes + +### DataGithubRepositoryPullRequestsResultsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryPullRequestsResultsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubRepositoryPullRequestsResultsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubRepositoryPullRequestsResultsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryPullRequestsResultsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| BaseRef | string | *No description.* | +| BaseSha | string | *No description.* | +| Body | string | *No description.* | +| Draft | Io.Cdktn.IResolvable | *No description.* | +| HeadOwner | string | *No description.* | +| HeadRef | string | *No description.* | +| HeadRepository | string | *No description.* | +| HeadSha | string | *No description.* | +| Labels | string[] | *No description.* | +| MaintainerCanModify | Io.Cdktn.IResolvable | *No description.* | +| Number | double | *No description.* | +| OpenedAt | double | *No description.* | +| OpenedBy | string | *No description.* | +| State | string | *No description.* | +| Title | string | *No description.* | +| UpdatedAt | double | *No description.* | +| InternalValue | DataGithubRepositoryPullRequestsResults | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `BaseRef`Required + +```csharp +public string BaseRef { get; } +``` + +- *Type:* string + +--- + +##### `BaseSha`Required + +```csharp +public string BaseSha { get; } +``` + +- *Type:* string + +--- + +##### `Body`Required + +```csharp +public string Body { get; } +``` + +- *Type:* string + +--- + +##### `Draft`Required + +```csharp +public IResolvable Draft { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `HeadOwner`Required + +```csharp +public string HeadOwner { get; } +``` + +- *Type:* string + +--- + +##### `HeadRef`Required + +```csharp +public string HeadRef { get; } +``` + +- *Type:* string + +--- + +##### `HeadRepository`Required + +```csharp +public string HeadRepository { get; } +``` + +- *Type:* string + +--- + +##### `HeadSha`Required + +```csharp +public string HeadSha { get; } +``` + +- *Type:* string + +--- + +##### `Labels`Required + +```csharp +public string[] Labels { get; } +``` + +- *Type:* string[] + +--- + +##### `MaintainerCanModify`Required + +```csharp +public IResolvable MaintainerCanModify { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `Number`Required + +```csharp +public double Number { get; } +``` + +- *Type:* double + +--- + +##### `OpenedAt`Required + +```csharp +public double OpenedAt { get; } +``` + +- *Type:* double + +--- + +##### `OpenedBy`Required + +```csharp +public string OpenedBy { get; } +``` + +- *Type:* string + +--- + +##### `State`Required + +```csharp +public string State { get; } +``` + +- *Type:* string + +--- + +##### `Title`Required + +```csharp +public string Title { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public double UpdatedAt { get; } +``` + +- *Type:* double + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubRepositoryPullRequestsResults InternalValue { get; } +``` + +- *Type:* DataGithubRepositoryPullRequestsResults + +--- + + + diff --git a/docs/dataGithubRepositoryPullRequests.java.md b/docs/dataGithubRepositoryPullRequests.java.md new file mode 100644 index 000000000..dfeb1991b --- /dev/null +++ b/docs/dataGithubRepositoryPullRequests.java.md @@ -0,0 +1,1755 @@ +# `dataGithubRepositoryPullRequests` Submodule + +## Constructs + +### DataGithubRepositoryPullRequests + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests github_repository_pull_requests}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_pull_requests.DataGithubRepositoryPullRequests; + +DataGithubRepositoryPullRequests.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .baseRepository(java.lang.String) +// .baseRef(java.lang.String) +// .headRef(java.lang.String) +// .id(java.lang.String) +// .owner(java.lang.String) +// .sortBy(java.lang.String) +// .sortDirection(java.lang.String) +// .state(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 | *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 | *No description.* | +| baseRepository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#base_repository DataGithubRepositoryPullRequests#base_repository}. | +| baseRef | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#base_ref DataGithubRepositoryPullRequests#base_ref}. | +| headRef | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#head_ref DataGithubRepositoryPullRequests#head_ref}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#id DataGithubRepositoryPullRequests#id}. | +| owner | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#owner DataGithubRepositoryPullRequests#owner}. | +| sortBy | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#sort_by DataGithubRepositoryPullRequests#sort_by}. | +| sortDirection | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#sort_direction DataGithubRepositoryPullRequests#sort_direction}. | +| state | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#state DataGithubRepositoryPullRequests#state}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `baseRepository`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#base_repository DataGithubRepositoryPullRequests#base_repository}. + +--- + +##### `baseRef`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#base_ref DataGithubRepositoryPullRequests#base_ref}. + +--- + +##### `headRef`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#head_ref DataGithubRepositoryPullRequests#head_ref}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#id DataGithubRepositoryPullRequests#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. + +--- + +##### `owner`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#owner DataGithubRepositoryPullRequests#owner}. + +--- + +##### `sortBy`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#sort_by DataGithubRepositoryPullRequests#sort_by}. + +--- + +##### `sortDirection`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#sort_direction DataGithubRepositoryPullRequests#sort_direction}. + +--- + +##### `state`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#state DataGithubRepositoryPullRequests#state}. + +--- + +#### 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.* | +| resetBaseRef | *No description.* | +| resetHeadRef | *No description.* | +| resetId | *No description.* | +| resetOwner | *No description.* | +| resetSortBy | *No description.* | +| resetSortDirection | *No description.* | +| resetState | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetBaseRef` + +```java +public void resetBaseRef() +``` + +##### `resetHeadRef` + +```java +public void resetHeadRef() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetOwner` + +```java +public void resetOwner() +``` + +##### `resetSortBy` + +```java +public void resetSortBy() +``` + +##### `resetSortDirection` + +```java +public void resetSortDirection() +``` + +##### `resetState` + +```java +public void resetState() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryPullRequests resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_repository_pull_requests.DataGithubRepositoryPullRequests; + +DataGithubRepositoryPullRequests.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` + +```java +import io.cdktn.providers.github.data_github_repository_pull_requests.DataGithubRepositoryPullRequests; + +DataGithubRepositoryPullRequests.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_repository_pull_requests.DataGithubRepositoryPullRequests; + +DataGithubRepositoryPullRequests.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_repository_pull_requests.DataGithubRepositoryPullRequests; + +DataGithubRepositoryPullRequests.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubRepositoryPullRequests.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubRepositoryPullRequests 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 DataGithubRepositoryPullRequests to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubRepositoryPullRequests that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#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 DataGithubRepositoryPullRequests 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| results | DataGithubRepositoryPullRequestsResultsList | *No description.* | +| baseRefInput | java.lang.String | *No description.* | +| baseRepositoryInput | java.lang.String | *No description.* | +| headRefInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| ownerInput | java.lang.String | *No description.* | +| sortByInput | java.lang.String | *No description.* | +| sortDirectionInput | java.lang.String | *No description.* | +| stateInput | java.lang.String | *No description.* | +| baseRef | java.lang.String | *No description.* | +| baseRepository | java.lang.String | *No description.* | +| headRef | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| owner | java.lang.String | *No description.* | +| sortBy | java.lang.String | *No description.* | +| sortDirection | java.lang.String | *No description.* | +| state | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `results`Required + +```java +public DataGithubRepositoryPullRequestsResultsList getResults(); +``` + +- *Type:* DataGithubRepositoryPullRequestsResultsList + +--- + +##### `baseRefInput`Optional + +```java +public java.lang.String getBaseRefInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `baseRepositoryInput`Optional + +```java +public java.lang.String getBaseRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `headRefInput`Optional + +```java +public java.lang.String getHeadRefInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `ownerInput`Optional + +```java +public java.lang.String getOwnerInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `sortByInput`Optional + +```java +public java.lang.String getSortByInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `sortDirectionInput`Optional + +```java +public java.lang.String getSortDirectionInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `stateInput`Optional + +```java +public java.lang.String getStateInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `baseRef`Required + +```java +public java.lang.String getBaseRef(); +``` + +- *Type:* java.lang.String + +--- + +##### `baseRepository`Required + +```java +public java.lang.String getBaseRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `headRef`Required + +```java +public java.lang.String getHeadRef(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `owner`Required + +```java +public java.lang.String getOwner(); +``` + +- *Type:* java.lang.String + +--- + +##### `sortBy`Required + +```java +public java.lang.String getSortBy(); +``` + +- *Type:* java.lang.String + +--- + +##### `sortDirection`Required + +```java +public java.lang.String getSortDirection(); +``` + +- *Type:* java.lang.String + +--- + +##### `state`Required + +```java +public java.lang.String getState(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubRepositoryPullRequestsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_pull_requests.DataGithubRepositoryPullRequestsConfig; + +DataGithubRepositoryPullRequestsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .baseRepository(java.lang.String) +// .baseRef(java.lang.String) +// .headRef(java.lang.String) +// .id(java.lang.String) +// .owner(java.lang.String) +// .sortBy(java.lang.String) +// .sortDirection(java.lang.String) +// .state(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 | *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 | *No description.* | +| baseRepository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#base_repository DataGithubRepositoryPullRequests#base_repository}. | +| baseRef | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#base_ref DataGithubRepositoryPullRequests#base_ref}. | +| headRef | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#head_ref DataGithubRepositoryPullRequests#head_ref}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#id DataGithubRepositoryPullRequests#id}. | +| owner | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#owner DataGithubRepositoryPullRequests#owner}. | +| sortBy | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#sort_by DataGithubRepositoryPullRequests#sort_by}. | +| sortDirection | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#sort_direction DataGithubRepositoryPullRequests#sort_direction}. | +| state | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#state DataGithubRepositoryPullRequests#state}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `baseRepository`Required + +```java +public java.lang.String getBaseRepository(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#base_repository DataGithubRepositoryPullRequests#base_repository}. + +--- + +##### `baseRef`Optional + +```java +public java.lang.String getBaseRef(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#base_ref DataGithubRepositoryPullRequests#base_ref}. + +--- + +##### `headRef`Optional + +```java +public java.lang.String getHeadRef(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#head_ref DataGithubRepositoryPullRequests#head_ref}. + +--- + +##### `id`Optional + +```java +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/repository_pull_requests#id DataGithubRepositoryPullRequests#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. + +--- + +##### `owner`Optional + +```java +public java.lang.String getOwner(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#owner DataGithubRepositoryPullRequests#owner}. + +--- + +##### `sortBy`Optional + +```java +public java.lang.String getSortBy(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#sort_by DataGithubRepositoryPullRequests#sort_by}. + +--- + +##### `sortDirection`Optional + +```java +public java.lang.String getSortDirection(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#sort_direction DataGithubRepositoryPullRequests#sort_direction}. + +--- + +##### `state`Optional + +```java +public java.lang.String getState(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_pull_requests#state DataGithubRepositoryPullRequests#state}. + +--- + +### DataGithubRepositoryPullRequestsResults + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_pull_requests.DataGithubRepositoryPullRequestsResults; + +DataGithubRepositoryPullRequestsResults.builder() + .build(); +``` + + +## Classes + +### DataGithubRepositoryPullRequestsResultsList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_pull_requests.DataGithubRepositoryPullRequestsResultsList; + +new DataGithubRepositoryPullRequestsResultsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubRepositoryPullRequestsResultsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubRepositoryPullRequestsResultsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_pull_requests.DataGithubRepositoryPullRequestsResultsOutputReference; + +new DataGithubRepositoryPullRequestsResultsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| baseRef | java.lang.String | *No description.* | +| baseSha | java.lang.String | *No description.* | +| body | java.lang.String | *No description.* | +| draft | io.cdktn.cdktn.IResolvable | *No description.* | +| headOwner | java.lang.String | *No description.* | +| headRef | java.lang.String | *No description.* | +| headRepository | java.lang.String | *No description.* | +| headSha | java.lang.String | *No description.* | +| labels | java.util.List | *No description.* | +| maintainerCanModify | io.cdktn.cdktn.IResolvable | *No description.* | +| number | java.lang.Number | *No description.* | +| openedAt | java.lang.Number | *No description.* | +| openedBy | java.lang.String | *No description.* | +| state | java.lang.String | *No description.* | +| title | java.lang.String | *No description.* | +| updatedAt | java.lang.Number | *No description.* | +| internalValue | DataGithubRepositoryPullRequestsResults | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `baseRef`Required + +```java +public java.lang.String getBaseRef(); +``` + +- *Type:* java.lang.String + +--- + +##### `baseSha`Required + +```java +public java.lang.String getBaseSha(); +``` + +- *Type:* java.lang.String + +--- + +##### `body`Required + +```java +public java.lang.String getBody(); +``` + +- *Type:* java.lang.String + +--- + +##### `draft`Required + +```java +public IResolvable getDraft(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `headOwner`Required + +```java +public java.lang.String getHeadOwner(); +``` + +- *Type:* java.lang.String + +--- + +##### `headRef`Required + +```java +public java.lang.String getHeadRef(); +``` + +- *Type:* java.lang.String + +--- + +##### `headRepository`Required + +```java +public java.lang.String getHeadRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `headSha`Required + +```java +public java.lang.String getHeadSha(); +``` + +- *Type:* java.lang.String + +--- + +##### `labels`Required + +```java +public java.util.List getLabels(); +``` + +- *Type:* java.util.List + +--- + +##### `maintainerCanModify`Required + +```java +public IResolvable getMaintainerCanModify(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `number`Required + +```java +public java.lang.Number getNumber(); +``` + +- *Type:* java.lang.Number + +--- + +##### `openedAt`Required + +```java +public java.lang.Number getOpenedAt(); +``` + +- *Type:* java.lang.Number + +--- + +##### `openedBy`Required + +```java +public java.lang.String getOpenedBy(); +``` + +- *Type:* java.lang.String + +--- + +##### `state`Required + +```java +public java.lang.String getState(); +``` + +- *Type:* java.lang.String + +--- + +##### `title`Required + +```java +public java.lang.String getTitle(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.Number getUpdatedAt(); +``` + +- *Type:* java.lang.Number + +--- + +##### `internalValue`Optional + +```java +public DataGithubRepositoryPullRequestsResults getInternalValue(); +``` + +- *Type:* DataGithubRepositoryPullRequestsResults + +--- + + + diff --git a/docs/dataGithubRepositoryTeams.csharp.md b/docs/dataGithubRepositoryTeams.csharp.md new file mode 100644 index 000000000..591bb8a36 --- /dev/null +++ b/docs/dataGithubRepositoryTeams.csharp.md @@ -0,0 +1,1272 @@ +# `dataGithubRepositoryTeams` Submodule + +## Constructs + +### DataGithubRepositoryTeams + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_teams github_repository_teams}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryTeams(Construct Scope, string Id, DataGithubRepositoryTeamsConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubRepositoryTeamsConfig | *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`Optional + +- *Type:* DataGithubRepositoryTeamsConfig + +--- + +#### 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.* | +| ResetFullName | *No description.* | +| ResetId | *No description.* | +| ResetName | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetFullName` + +```csharp +private void ResetFullName() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetName` + +```csharp +private void ResetName() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryTeams resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryTeams.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryTeams.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryTeams.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryTeams.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubRepositoryTeams resource upon running "cdktn 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 DataGithubRepositoryTeams to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubRepositoryTeams that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_teams#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubRepositoryTeams to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Teams | DataGithubRepositoryTeamsTeamsList | *No description.* | +| FullNameInput | string | *No description.* | +| IdInput | string | *No description.* | +| NameInput | string | *No description.* | +| FullName | string | *No description.* | +| Id | string | *No description.* | +| Name | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Teams`Required + +```csharp +public DataGithubRepositoryTeamsTeamsList Teams { get; } +``` + +- *Type:* DataGithubRepositoryTeamsTeamsList + +--- + +##### `FullNameInput`Optional + +```csharp +public string FullNameInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `FullName`Required + +```csharp +public string FullName { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubRepositoryTeamsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryTeamsConfig { + 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 FullName = null, + string Id = null, + string Name = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| FullName | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_teams#full_name DataGithubRepositoryTeams#full_name}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_teams#id DataGithubRepositoryTeams#id}. | +| Name | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_teams#name DataGithubRepositoryTeams#name}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `FullName`Optional + +```csharp +public string FullName { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_teams#full_name DataGithubRepositoryTeams#full_name}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_teams#id DataGithubRepositoryTeams#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. + +--- + +##### `Name`Optional + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_teams#name DataGithubRepositoryTeams#name}. + +--- + +### DataGithubRepositoryTeamsTeams + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryTeamsTeams { + +}; +``` + + +## Classes + +### DataGithubRepositoryTeamsTeamsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryTeamsTeamsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubRepositoryTeamsTeamsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubRepositoryTeamsTeamsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryTeamsTeamsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Name | string | *No description.* | +| Permission | string | *No description.* | +| Slug | string | *No description.* | +| InternalValue | DataGithubRepositoryTeamsTeams | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Permission`Required + +```csharp +public string Permission { get; } +``` + +- *Type:* string + +--- + +##### `Slug`Required + +```csharp +public string Slug { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubRepositoryTeamsTeams InternalValue { get; } +``` + +- *Type:* DataGithubRepositoryTeamsTeams + +--- + + + diff --git a/docs/dataGithubRepositoryTeams.java.md b/docs/dataGithubRepositoryTeams.java.md new file mode 100644 index 000000000..289fd4fde --- /dev/null +++ b/docs/dataGithubRepositoryTeams.java.md @@ -0,0 +1,1354 @@ +# `dataGithubRepositoryTeams` Submodule + +## Constructs + +### DataGithubRepositoryTeams + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_teams github_repository_teams}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_teams.DataGithubRepositoryTeams; + +DataGithubRepositoryTeams.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .fullName(java.lang.String) +// .id(java.lang.String) +// .name(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 | *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 | *No description.* | +| fullName | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_teams#full_name DataGithubRepositoryTeams#full_name}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_teams#id DataGithubRepositoryTeams#id}. | +| name | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_teams#name DataGithubRepositoryTeams#name}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `fullName`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_teams#full_name DataGithubRepositoryTeams#full_name}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_teams#id DataGithubRepositoryTeams#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. + +--- + +##### `name`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_teams#name DataGithubRepositoryTeams#name}. + +--- + +#### 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.* | +| resetFullName | *No description.* | +| resetId | *No description.* | +| resetName | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetFullName` + +```java +public void resetFullName() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetName` + +```java +public void resetName() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryTeams resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_repository_teams.DataGithubRepositoryTeams; + +DataGithubRepositoryTeams.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` + +```java +import io.cdktn.providers.github.data_github_repository_teams.DataGithubRepositoryTeams; + +DataGithubRepositoryTeams.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_repository_teams.DataGithubRepositoryTeams; + +DataGithubRepositoryTeams.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_repository_teams.DataGithubRepositoryTeams; + +DataGithubRepositoryTeams.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubRepositoryTeams.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubRepositoryTeams 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 DataGithubRepositoryTeams to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubRepositoryTeams that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_teams#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 DataGithubRepositoryTeams 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| teams | DataGithubRepositoryTeamsTeamsList | *No description.* | +| fullNameInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| fullName | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `teams`Required + +```java +public DataGithubRepositoryTeamsTeamsList getTeams(); +``` + +- *Type:* DataGithubRepositoryTeamsTeamsList + +--- + +##### `fullNameInput`Optional + +```java +public java.lang.String getFullNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `fullName`Required + +```java +public java.lang.String getFullName(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubRepositoryTeamsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_teams.DataGithubRepositoryTeamsConfig; + +DataGithubRepositoryTeamsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .fullName(java.lang.String) +// .id(java.lang.String) +// .name(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 | *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 | *No description.* | +| fullName | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_teams#full_name DataGithubRepositoryTeams#full_name}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_teams#id DataGithubRepositoryTeams#id}. | +| name | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_teams#name DataGithubRepositoryTeams#name}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `fullName`Optional + +```java +public java.lang.String getFullName(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_teams#full_name DataGithubRepositoryTeams#full_name}. + +--- + +##### `id`Optional + +```java +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/repository_teams#id DataGithubRepositoryTeams#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. + +--- + +##### `name`Optional + +```java +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/repository_teams#name DataGithubRepositoryTeams#name}. + +--- + +### DataGithubRepositoryTeamsTeams + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_teams.DataGithubRepositoryTeamsTeams; + +DataGithubRepositoryTeamsTeams.builder() + .build(); +``` + + +## Classes + +### DataGithubRepositoryTeamsTeamsList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_teams.DataGithubRepositoryTeamsTeamsList; + +new DataGithubRepositoryTeamsTeamsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubRepositoryTeamsTeamsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubRepositoryTeamsTeamsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_teams.DataGithubRepositoryTeamsTeamsOutputReference; + +new DataGithubRepositoryTeamsTeamsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| permission | java.lang.String | *No description.* | +| slug | java.lang.String | *No description.* | +| internalValue | DataGithubRepositoryTeamsTeams | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `permission`Required + +```java +public java.lang.String getPermission(); +``` + +- *Type:* java.lang.String + +--- + +##### `slug`Required + +```java +public java.lang.String getSlug(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubRepositoryTeamsTeams getInternalValue(); +``` + +- *Type:* DataGithubRepositoryTeamsTeams + +--- + + + diff --git a/docs/dataGithubRepositoryWebhooks.csharp.md b/docs/dataGithubRepositoryWebhooks.csharp.md new file mode 100644 index 000000000..cd5493855 --- /dev/null +++ b/docs/dataGithubRepositoryWebhooks.csharp.md @@ -0,0 +1,1244 @@ +# `dataGithubRepositoryWebhooks` Submodule + +## Constructs + +### DataGithubRepositoryWebhooks + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_webhooks github_repository_webhooks}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryWebhooks(Construct Scope, string Id, DataGithubRepositoryWebhooksConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubRepositoryWebhooksConfig | *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:* DataGithubRepositoryWebhooksConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryWebhooks resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryWebhooks.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryWebhooks.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryWebhooks.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRepositoryWebhooks.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubRepositoryWebhooks resource upon running "cdktn 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 DataGithubRepositoryWebhooks to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubRepositoryWebhooks that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_webhooks#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubRepositoryWebhooks to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Webhooks | DataGithubRepositoryWebhooksWebhooksList | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Webhooks`Required + +```csharp +public DataGithubRepositoryWebhooksWebhooksList Webhooks { get; } +``` + +- *Type:* DataGithubRepositoryWebhooksWebhooksList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubRepositoryWebhooksConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryWebhooksConfig { + 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 Repository, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_webhooks#repository DataGithubRepositoryWebhooks#repository}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_webhooks#id DataGithubRepositoryWebhooks#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_webhooks#repository DataGithubRepositoryWebhooks#repository}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_webhooks#id DataGithubRepositoryWebhooks#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. + +--- + +### DataGithubRepositoryWebhooksWebhooks + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryWebhooksWebhooks { + +}; +``` + + +## Classes + +### DataGithubRepositoryWebhooksWebhooksList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryWebhooksWebhooksList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubRepositoryWebhooksWebhooksOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubRepositoryWebhooksWebhooksOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRepositoryWebhooksWebhooksOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Active | Io.Cdktn.IResolvable | *No description.* | +| Id | double | *No description.* | +| Name | string | *No description.* | +| Type | string | *No description.* | +| Url | string | *No description.* | +| InternalValue | DataGithubRepositoryWebhooksWebhooks | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Active`Required + +```csharp +public IResolvable Active { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `Id`Required + +```csharp +public double Id { get; } +``` + +- *Type:* double + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Type`Required + +```csharp +public string Type { get; } +``` + +- *Type:* string + +--- + +##### `Url`Required + +```csharp +public string Url { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubRepositoryWebhooksWebhooks InternalValue { get; } +``` + +- *Type:* DataGithubRepositoryWebhooksWebhooks + +--- + + + diff --git a/docs/dataGithubRepositoryWebhooks.java.md b/docs/dataGithubRepositoryWebhooks.java.md new file mode 100644 index 000000000..16484886a --- /dev/null +++ b/docs/dataGithubRepositoryWebhooks.java.md @@ -0,0 +1,1316 @@ +# `dataGithubRepositoryWebhooks` Submodule + +## Constructs + +### DataGithubRepositoryWebhooks + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_webhooks github_repository_webhooks}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_webhooks.DataGithubRepositoryWebhooks; + +DataGithubRepositoryWebhooks.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_webhooks#repository DataGithubRepositoryWebhooks#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_webhooks#id DataGithubRepositoryWebhooks#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_webhooks#repository DataGithubRepositoryWebhooks#repository}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_webhooks#id DataGithubRepositoryWebhooks#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubRepositoryWebhooks resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_repository_webhooks.DataGithubRepositoryWebhooks; + +DataGithubRepositoryWebhooks.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` + +```java +import io.cdktn.providers.github.data_github_repository_webhooks.DataGithubRepositoryWebhooks; + +DataGithubRepositoryWebhooks.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_repository_webhooks.DataGithubRepositoryWebhooks; + +DataGithubRepositoryWebhooks.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_repository_webhooks.DataGithubRepositoryWebhooks; + +DataGithubRepositoryWebhooks.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubRepositoryWebhooks.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubRepositoryWebhooks 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 DataGithubRepositoryWebhooks to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubRepositoryWebhooks that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_webhooks#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 DataGithubRepositoryWebhooks 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| webhooks | DataGithubRepositoryWebhooksWebhooksList | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `webhooks`Required + +```java +public DataGithubRepositoryWebhooksWebhooksList getWebhooks(); +``` + +- *Type:* DataGithubRepositoryWebhooksWebhooksList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubRepositoryWebhooksConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_webhooks.DataGithubRepositoryWebhooksConfig; + +DataGithubRepositoryWebhooksConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_webhooks#repository DataGithubRepositoryWebhooks#repository}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_webhooks#id DataGithubRepositoryWebhooks#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repository_webhooks#repository DataGithubRepositoryWebhooks#repository}. + +--- + +##### `id`Optional + +```java +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/repository_webhooks#id DataGithubRepositoryWebhooks#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. + +--- + +### DataGithubRepositoryWebhooksWebhooks + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_repository_webhooks.DataGithubRepositoryWebhooksWebhooks; + +DataGithubRepositoryWebhooksWebhooks.builder() + .build(); +``` + + +## Classes + +### DataGithubRepositoryWebhooksWebhooksList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_webhooks.DataGithubRepositoryWebhooksWebhooksList; + +new DataGithubRepositoryWebhooksWebhooksList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubRepositoryWebhooksWebhooksOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubRepositoryWebhooksWebhooksOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_repository_webhooks.DataGithubRepositoryWebhooksWebhooksOutputReference; + +new DataGithubRepositoryWebhooksWebhooksOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| active | io.cdktn.cdktn.IResolvable | *No description.* | +| id | java.lang.Number | *No description.* | +| name | java.lang.String | *No description.* | +| type | java.lang.String | *No description.* | +| url | java.lang.String | *No description.* | +| internalValue | DataGithubRepositoryWebhooksWebhooks | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `active`Required + +```java +public IResolvable getActive(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `id`Required + +```java +public java.lang.Number getId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `type`Required + +```java +public java.lang.String getType(); +``` + +- *Type:* java.lang.String + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubRepositoryWebhooksWebhooks getInternalValue(); +``` + +- *Type:* DataGithubRepositoryWebhooksWebhooks + +--- + + + diff --git a/docs/dataGithubRestApi.csharp.md b/docs/dataGithubRestApi.csharp.md new file mode 100644 index 000000000..886030faa --- /dev/null +++ b/docs/dataGithubRestApi.csharp.md @@ -0,0 +1,792 @@ +# `dataGithubRestApi` Submodule + +## Constructs + +### DataGithubRestApi + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/rest_api github_rest_api}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRestApi(Construct Scope, string Id, DataGithubRestApiConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubRestApiConfig | *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:* DataGithubRestApiConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubRestApi resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRestApi.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRestApi.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRestApi.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubRestApi.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubRestApi resource upon running "cdktn 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 DataGithubRestApi to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubRestApi that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/rest_api#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubRestApi to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Body | string | *No description.* | +| Code | double | *No description.* | +| Headers | string | *No description.* | +| Status | string | *No description.* | +| EndpointInput | string | *No description.* | +| IdInput | string | *No description.* | +| Endpoint | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Body`Required + +```csharp +public string Body { get; } +``` + +- *Type:* string + +--- + +##### `Code`Required + +```csharp +public double Code { get; } +``` + +- *Type:* double + +--- + +##### `Headers`Required + +```csharp +public string Headers { get; } +``` + +- *Type:* string + +--- + +##### `Status`Required + +```csharp +public string Status { get; } +``` + +- *Type:* string + +--- + +##### `EndpointInput`Optional + +```csharp +public string EndpointInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Endpoint`Required + +```csharp +public string Endpoint { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubRestApiConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubRestApiConfig { + 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 Endpoint, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Endpoint | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/rest_api#endpoint DataGithubRestApi#endpoint}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/rest_api#id DataGithubRestApi#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Endpoint`Required + +```csharp +public string Endpoint { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/rest_api#endpoint DataGithubRestApi#endpoint}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/rest_api#id DataGithubRestApi#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. + +--- + + + diff --git a/docs/dataGithubRestApi.java.md b/docs/dataGithubRestApi.java.md new file mode 100644 index 000000000..e5d1f5269 --- /dev/null +++ b/docs/dataGithubRestApi.java.md @@ -0,0 +1,865 @@ +# `dataGithubRestApi` Submodule + +## Constructs + +### DataGithubRestApi + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/rest_api github_rest_api}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_rest_api.DataGithubRestApi; + +DataGithubRestApi.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .endpoint(java.lang.String) +// .id(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 | *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 | *No description.* | +| endpoint | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/rest_api#endpoint DataGithubRestApi#endpoint}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/rest_api#id DataGithubRestApi#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `endpoint`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/rest_api#endpoint DataGithubRestApi#endpoint}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/rest_api#id DataGithubRestApi#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubRestApi resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_rest_api.DataGithubRestApi; + +DataGithubRestApi.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` + +```java +import io.cdktn.providers.github.data_github_rest_api.DataGithubRestApi; + +DataGithubRestApi.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_rest_api.DataGithubRestApi; + +DataGithubRestApi.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_rest_api.DataGithubRestApi; + +DataGithubRestApi.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubRestApi.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubRestApi 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 DataGithubRestApi to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubRestApi that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/rest_api#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 DataGithubRestApi 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| body | java.lang.String | *No description.* | +| code | java.lang.Number | *No description.* | +| headers | java.lang.String | *No description.* | +| status | java.lang.String | *No description.* | +| endpointInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| endpoint | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `body`Required + +```java +public java.lang.String getBody(); +``` + +- *Type:* java.lang.String + +--- + +##### `code`Required + +```java +public java.lang.Number getCode(); +``` + +- *Type:* java.lang.Number + +--- + +##### `headers`Required + +```java +public java.lang.String getHeaders(); +``` + +- *Type:* java.lang.String + +--- + +##### `status`Required + +```java +public java.lang.String getStatus(); +``` + +- *Type:* java.lang.String + +--- + +##### `endpointInput`Optional + +```java +public java.lang.String getEndpointInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `endpoint`Required + +```java +public java.lang.String getEndpoint(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubRestApiConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_rest_api.DataGithubRestApiConfig; + +DataGithubRestApiConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .endpoint(java.lang.String) +// .id(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 | *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 | *No description.* | +| endpoint | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/rest_api#endpoint DataGithubRestApi#endpoint}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/rest_api#id DataGithubRestApi#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `endpoint`Required + +```java +public java.lang.String getEndpoint(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/rest_api#endpoint DataGithubRestApi#endpoint}. + +--- + +##### `id`Optional + +```java +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/rest_api#id DataGithubRestApi#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. + +--- + + + diff --git a/docs/dataGithubSshKeys.csharp.md b/docs/dataGithubSshKeys.csharp.md new file mode 100644 index 000000000..ab544fd89 --- /dev/null +++ b/docs/dataGithubSshKeys.csharp.md @@ -0,0 +1,723 @@ +# `dataGithubSshKeys` Submodule + +## Constructs + +### DataGithubSshKeys + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ssh_keys github_ssh_keys}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubSshKeys(Construct Scope, string Id, DataGithubSshKeysConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubSshKeysConfig | *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`Optional + +- *Type:* DataGithubSshKeysConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubSshKeys resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubSshKeys.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubSshKeys.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubSshKeys.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubSshKeys.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubSshKeys resource upon running "cdktn 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 DataGithubSshKeys to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubSshKeys that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ssh_keys#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubSshKeys to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Keys | string[] | *No description.* | +| IdInput | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Keys`Required + +```csharp +public string[] Keys { get; } +``` + +- *Type:* string[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubSshKeysConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubSshKeysConfig { + 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 Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ssh_keys#id DataGithubSshKeys#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ssh_keys#id DataGithubSshKeys#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. + +--- + + + diff --git a/docs/dataGithubSshKeys.java.md b/docs/dataGithubSshKeys.java.md new file mode 100644 index 000000000..ad830e300 --- /dev/null +++ b/docs/dataGithubSshKeys.java.md @@ -0,0 +1,786 @@ +# `dataGithubSshKeys` Submodule + +## Constructs + +### DataGithubSshKeys + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ssh_keys github_ssh_keys}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_ssh_keys.DataGithubSshKeys; + +DataGithubSshKeys.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ssh_keys#id DataGithubSshKeys#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ssh_keys#id DataGithubSshKeys#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubSshKeys resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_ssh_keys.DataGithubSshKeys; + +DataGithubSshKeys.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` + +```java +import io.cdktn.providers.github.data_github_ssh_keys.DataGithubSshKeys; + +DataGithubSshKeys.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_ssh_keys.DataGithubSshKeys; + +DataGithubSshKeys.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_ssh_keys.DataGithubSshKeys; + +DataGithubSshKeys.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubSshKeys.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubSshKeys 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 DataGithubSshKeys to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubSshKeys that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ssh_keys#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 DataGithubSshKeys 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| keys | java.util.List | *No description.* | +| idInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `keys`Required + +```java +public java.util.List getKeys(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubSshKeysConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_ssh_keys.DataGithubSshKeysConfig; + +DataGithubSshKeysConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .id(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 | *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 | *No description.* | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/ssh_keys#id DataGithubSshKeys#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Optional + +```java +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/ssh_keys#id DataGithubSshKeys#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. + +--- + + + diff --git a/docs/dataGithubTeam.csharp.md b/docs/dataGithubTeam.csharp.md new file mode 100644 index 000000000..72e7f1c44 --- /dev/null +++ b/docs/dataGithubTeam.csharp.md @@ -0,0 +1,1439 @@ +# `dataGithubTeam` Submodule + +## Constructs + +### DataGithubTeam + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team github_team}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubTeam(Construct Scope, string Id, DataGithubTeamConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubTeamConfig | *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:* DataGithubTeamConfig + +--- + +#### 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.* | +| ResetMembershipType | *No description.* | +| ResetResultsPerPage | *No description.* | +| ResetSummaryOnly | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetMembershipType` + +```csharp +private void ResetMembershipType() +``` + +##### `ResetResultsPerPage` + +```csharp +private void ResetResultsPerPage() +``` + +##### `ResetSummaryOnly` + +```csharp +private void ResetSummaryOnly() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubTeam resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubTeam.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubTeam.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubTeam.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubTeam.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubTeam resource upon running "cdktn 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 DataGithubTeam to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubTeam that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubTeam to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Description | string | *No description.* | +| Members | string[] | *No description.* | +| Name | string | *No description.* | +| NodeId | string | *No description.* | +| NotificationSetting | string | *No description.* | +| Permission | string | *No description.* | +| Privacy | string | *No description.* | +| Repositories | string[] | *No description.* | +| RepositoriesDetailed | DataGithubTeamRepositoriesDetailedList | *No description.* | +| IdInput | string | *No description.* | +| MembershipTypeInput | string | *No description.* | +| ResultsPerPageInput | double | *No description.* | +| SlugInput | string | *No description.* | +| SummaryOnlyInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| Id | string | *No description.* | +| MembershipType | string | *No description.* | +| ResultsPerPage | double | *No description.* | +| Slug | string | *No description.* | +| SummaryOnly | bool\|Io.Cdktn.IResolvable | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `Members`Required + +```csharp +public string[] Members { get; } +``` + +- *Type:* string[] + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `NodeId`Required + +```csharp +public string NodeId { get; } +``` + +- *Type:* string + +--- + +##### `NotificationSetting`Required + +```csharp +public string NotificationSetting { get; } +``` + +- *Type:* string + +--- + +##### `Permission`Required + +```csharp +public string Permission { get; } +``` + +- *Type:* string + +--- + +##### `Privacy`Required + +```csharp +public string Privacy { get; } +``` + +- *Type:* string + +--- + +##### `Repositories`Required + +```csharp +public string[] Repositories { get; } +``` + +- *Type:* string[] + +--- + +##### `RepositoriesDetailed`Required + +```csharp +public DataGithubTeamRepositoriesDetailedList RepositoriesDetailed { get; } +``` + +- *Type:* DataGithubTeamRepositoriesDetailedList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `MembershipTypeInput`Optional + +```csharp +public string MembershipTypeInput { get; } +``` + +- *Type:* string + +--- + +##### `ResultsPerPageInput`Optional + +```csharp +public double ResultsPerPageInput { get; } +``` + +- *Type:* double + +--- + +##### `SlugInput`Optional + +```csharp +public string SlugInput { get; } +``` + +- *Type:* string + +--- + +##### `SummaryOnlyInput`Optional + +```csharp +public bool|IResolvable SummaryOnlyInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `MembershipType`Required + +```csharp +public string MembershipType { get; } +``` + +- *Type:* string + +--- + +##### `ResultsPerPage`Required + +```csharp +public double ResultsPerPage { get; } +``` + +- *Type:* double + +--- + +##### `Slug`Required + +```csharp +public string Slug { get; } +``` + +- *Type:* string + +--- + +##### `SummaryOnly`Required + +```csharp +public bool|IResolvable SummaryOnly { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubTeamConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubTeamConfig { + 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 Slug, + string Id = null, + string MembershipType = null, + double ResultsPerPage = null, + bool|IResolvable SummaryOnly = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Slug | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#slug DataGithubTeam#slug}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#id DataGithubTeam#id}. | +| MembershipType | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#membership_type DataGithubTeam#membership_type}. | +| ResultsPerPage | double | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#results_per_page DataGithubTeam#results_per_page}. | +| SummaryOnly | bool\|Io.Cdktn.IResolvable | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#summary_only DataGithubTeam#summary_only}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Slug`Required + +```csharp +public string Slug { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#slug DataGithubTeam#slug}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#id DataGithubTeam#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. + +--- + +##### `MembershipType`Optional + +```csharp +public string MembershipType { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#membership_type DataGithubTeam#membership_type}. + +--- + +##### `ResultsPerPage`Optional + +```csharp +public double ResultsPerPage { get; set; } +``` + +- *Type:* double + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#results_per_page DataGithubTeam#results_per_page}. + +--- + +##### `SummaryOnly`Optional + +```csharp +public bool|IResolvable SummaryOnly { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#summary_only DataGithubTeam#summary_only}. + +--- + +### DataGithubTeamRepositoriesDetailed + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubTeamRepositoriesDetailed { + +}; +``` + + +## Classes + +### DataGithubTeamRepositoriesDetailedList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubTeamRepositoriesDetailedList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubTeamRepositoriesDetailedOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubTeamRepositoriesDetailedOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubTeamRepositoriesDetailedOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| RepoId | double | *No description.* | +| RepoName | string | *No description.* | +| RoleName | string | *No description.* | +| InternalValue | DataGithubTeamRepositoriesDetailed | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `RepoId`Required + +```csharp +public double RepoId { get; } +``` + +- *Type:* double + +--- + +##### `RepoName`Required + +```csharp +public string RepoName { get; } +``` + +- *Type:* string + +--- + +##### `RoleName`Required + +```csharp +public string RoleName { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubTeamRepositoriesDetailed InternalValue { get; } +``` + +- *Type:* DataGithubTeamRepositoriesDetailed + +--- + + + diff --git a/docs/dataGithubTeam.java.md b/docs/dataGithubTeam.java.md new file mode 100644 index 000000000..47599ba94 --- /dev/null +++ b/docs/dataGithubTeam.java.md @@ -0,0 +1,1541 @@ +# `dataGithubTeam` Submodule + +## Constructs + +### DataGithubTeam + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team github_team}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_team.DataGithubTeam; + +DataGithubTeam.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .slug(java.lang.String) +// .id(java.lang.String) +// .membershipType(java.lang.String) +// .resultsPerPage(java.lang.Number) +// .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 | *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 | *No description.* | +| slug | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#slug DataGithubTeam#slug}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#id DataGithubTeam#id}. | +| membershipType | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#membership_type DataGithubTeam#membership_type}. | +| resultsPerPage | java.lang.Number | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#results_per_page DataGithubTeam#results_per_page}. | +| 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/team#summary_only DataGithubTeam#summary_only}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `slug`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#slug DataGithubTeam#slug}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#id DataGithubTeam#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. + +--- + +##### `membershipType`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#membership_type DataGithubTeam#membership_type}. + +--- + +##### `resultsPerPage`Optional + +- *Type:* java.lang.Number + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#results_per_page DataGithubTeam#results_per_page}. + +--- + +##### `summaryOnly`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/team#summary_only DataGithubTeam#summary_only}. + +--- + +#### 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.* | +| resetMembershipType | *No description.* | +| resetResultsPerPage | *No description.* | +| resetSummaryOnly | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetMembershipType` + +```java +public void resetMembershipType() +``` + +##### `resetResultsPerPage` + +```java +public void resetResultsPerPage() +``` + +##### `resetSummaryOnly` + +```java +public void resetSummaryOnly() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubTeam resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_team.DataGithubTeam; + +DataGithubTeam.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` + +```java +import io.cdktn.providers.github.data_github_team.DataGithubTeam; + +DataGithubTeam.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_team.DataGithubTeam; + +DataGithubTeam.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_team.DataGithubTeam; + +DataGithubTeam.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubTeam.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubTeam 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 DataGithubTeam to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubTeam that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#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 DataGithubTeam 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| description | java.lang.String | *No description.* | +| members | java.util.List | *No description.* | +| name | java.lang.String | *No description.* | +| nodeId | java.lang.String | *No description.* | +| notificationSetting | java.lang.String | *No description.* | +| permission | java.lang.String | *No description.* | +| privacy | java.lang.String | *No description.* | +| repositories | java.util.List | *No description.* | +| repositoriesDetailed | DataGithubTeamRepositoriesDetailedList | *No description.* | +| idInput | java.lang.String | *No description.* | +| membershipTypeInput | java.lang.String | *No description.* | +| resultsPerPageInput | java.lang.Number | *No description.* | +| slugInput | java.lang.String | *No description.* | +| summaryOnlyInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| id | java.lang.String | *No description.* | +| membershipType | java.lang.String | *No description.* | +| resultsPerPage | java.lang.Number | *No description.* | +| slug | java.lang.String | *No description.* | +| summaryOnly | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `members`Required + +```java +public java.util.List getMembers(); +``` + +- *Type:* java.util.List + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `nodeId`Required + +```java +public java.lang.String getNodeId(); +``` + +- *Type:* java.lang.String + +--- + +##### `notificationSetting`Required + +```java +public java.lang.String getNotificationSetting(); +``` + +- *Type:* java.lang.String + +--- + +##### `permission`Required + +```java +public java.lang.String getPermission(); +``` + +- *Type:* java.lang.String + +--- + +##### `privacy`Required + +```java +public java.lang.String getPrivacy(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositories`Required + +```java +public java.util.List getRepositories(); +``` + +- *Type:* java.util.List + +--- + +##### `repositoriesDetailed`Required + +```java +public DataGithubTeamRepositoriesDetailedList getRepositoriesDetailed(); +``` + +- *Type:* DataGithubTeamRepositoriesDetailedList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `membershipTypeInput`Optional + +```java +public java.lang.String getMembershipTypeInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `resultsPerPageInput`Optional + +```java +public java.lang.Number getResultsPerPageInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `slugInput`Optional + +```java +public java.lang.String getSlugInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `summaryOnlyInput`Optional + +```java +public java.lang.Boolean|IResolvable getSummaryOnlyInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `membershipType`Required + +```java +public java.lang.String getMembershipType(); +``` + +- *Type:* java.lang.String + +--- + +##### `resultsPerPage`Required + +```java +public java.lang.Number getResultsPerPage(); +``` + +- *Type:* java.lang.Number + +--- + +##### `slug`Required + +```java +public java.lang.String getSlug(); +``` + +- *Type:* java.lang.String + +--- + +##### `summaryOnly`Required + +```java +public java.lang.Boolean|IResolvable getSummaryOnly(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubTeamConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_team.DataGithubTeamConfig; + +DataGithubTeamConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .slug(java.lang.String) +// .id(java.lang.String) +// .membershipType(java.lang.String) +// .resultsPerPage(java.lang.Number) +// .summaryOnly(java.lang.Boolean|IResolvable) + .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 | *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 | *No description.* | +| slug | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#slug DataGithubTeam#slug}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#id DataGithubTeam#id}. | +| membershipType | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#membership_type DataGithubTeam#membership_type}. | +| resultsPerPage | java.lang.Number | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#results_per_page DataGithubTeam#results_per_page}. | +| 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/team#summary_only DataGithubTeam#summary_only}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `slug`Required + +```java +public java.lang.String getSlug(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#slug DataGithubTeam#slug}. + +--- + +##### `id`Optional + +```java +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/team#id DataGithubTeam#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. + +--- + +##### `membershipType`Optional + +```java +public java.lang.String getMembershipType(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/team#membership_type DataGithubTeam#membership_type}. + +--- + +##### `resultsPerPage`Optional + +```java +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/team#results_per_page DataGithubTeam#results_per_page}. + +--- + +##### `summaryOnly`Optional + +```java +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/team#summary_only DataGithubTeam#summary_only}. + +--- + +### DataGithubTeamRepositoriesDetailed + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_team.DataGithubTeamRepositoriesDetailed; + +DataGithubTeamRepositoriesDetailed.builder() + .build(); +``` + + +## Classes + +### DataGithubTeamRepositoriesDetailedList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_team.DataGithubTeamRepositoriesDetailedList; + +new DataGithubTeamRepositoriesDetailedList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubTeamRepositoriesDetailedOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubTeamRepositoriesDetailedOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_team.DataGithubTeamRepositoriesDetailedOutputReference; + +new DataGithubTeamRepositoriesDetailedOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| repoId | java.lang.Number | *No description.* | +| repoName | java.lang.String | *No description.* | +| roleName | java.lang.String | *No description.* | +| internalValue | DataGithubTeamRepositoriesDetailed | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `repoId`Required + +```java +public java.lang.Number getRepoId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `repoName`Required + +```java +public java.lang.String getRepoName(); +``` + +- *Type:* java.lang.String + +--- + +##### `roleName`Required + +```java +public java.lang.String getRoleName(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubTeamRepositoriesDetailed getInternalValue(); +``` + +- *Type:* DataGithubTeamRepositoriesDetailed + +--- + + + diff --git a/docs/dataGithubTree.csharp.md b/docs/dataGithubTree.csharp.md new file mode 100644 index 000000000..32d91ffdf --- /dev/null +++ b/docs/dataGithubTree.csharp.md @@ -0,0 +1,1323 @@ +# `dataGithubTree` Submodule + +## Constructs + +### DataGithubTree + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/tree github_tree}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubTree(Construct Scope, string Id, DataGithubTreeConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubTreeConfig | *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:* DataGithubTreeConfig + +--- + +#### 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.* | +| ResetRecursive | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetRecursive` + +```csharp +private void ResetRecursive() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubTree resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubTree.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubTree.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubTree.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubTree.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubTree resource upon running "cdktn 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 DataGithubTree to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubTree that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/tree#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubTree to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Entries | DataGithubTreeEntriesList | *No description.* | +| IdInput | string | *No description.* | +| RecursiveInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RepositoryInput | string | *No description.* | +| TreeShaInput | string | *No description.* | +| Id | string | *No description.* | +| Recursive | bool\|Io.Cdktn.IResolvable | *No description.* | +| Repository | string | *No description.* | +| TreeSha | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Entries`Required + +```csharp +public DataGithubTreeEntriesList Entries { get; } +``` + +- *Type:* DataGithubTreeEntriesList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RecursiveInput`Optional + +```csharp +public bool|IResolvable RecursiveInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `TreeShaInput`Optional + +```csharp +public string TreeShaInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Recursive`Required + +```csharp +public bool|IResolvable Recursive { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `TreeSha`Required + +```csharp +public string TreeSha { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubTreeConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubTreeConfig { + 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 Repository, + string TreeSha, + string Id = null, + bool|IResolvable Recursive = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/tree#repository DataGithubTree#repository}. | +| TreeSha | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/tree#tree_sha DataGithubTree#tree_sha}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/tree#id DataGithubTree#id}. | +| Recursive | bool\|Io.Cdktn.IResolvable | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/tree#recursive DataGithubTree#recursive}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/tree#repository DataGithubTree#repository}. + +--- + +##### `TreeSha`Required + +```csharp +public string TreeSha { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/tree#tree_sha DataGithubTree#tree_sha}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/tree#id DataGithubTree#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. + +--- + +##### `Recursive`Optional + +```csharp +public bool|IResolvable Recursive { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/tree#recursive DataGithubTree#recursive}. + +--- + +### DataGithubTreeEntries + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubTreeEntries { + +}; +``` + + +## Classes + +### DataGithubTreeEntriesList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubTreeEntriesList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private DataGithubTreeEntriesOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + + +### DataGithubTreeEntriesOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubTreeEntriesOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Mode | string | *No description.* | +| Path | string | *No description.* | +| Sha | string | *No description.* | +| Size | double | *No description.* | +| Type | string | *No description.* | +| InternalValue | DataGithubTreeEntries | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Mode`Required + +```csharp +public string Mode { get; } +``` + +- *Type:* string + +--- + +##### `Path`Required + +```csharp +public string Path { get; } +``` + +- *Type:* string + +--- + +##### `Sha`Required + +```csharp +public string Sha { get; } +``` + +- *Type:* string + +--- + +##### `Size`Required + +```csharp +public double Size { get; } +``` + +- *Type:* double + +--- + +##### `Type`Required + +```csharp +public string Type { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public DataGithubTreeEntries InternalValue { get; } +``` + +- *Type:* DataGithubTreeEntries + +--- + + + diff --git a/docs/dataGithubTree.java.md b/docs/dataGithubTree.java.md new file mode 100644 index 000000000..a0382df3f --- /dev/null +++ b/docs/dataGithubTree.java.md @@ -0,0 +1,1415 @@ +# `dataGithubTree` Submodule + +## Constructs + +### DataGithubTree + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/tree github_tree}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_tree.DataGithubTree; + +DataGithubTree.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) + .treeSha(java.lang.String) +// .id(java.lang.String) +// .recursive(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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/tree#repository DataGithubTree#repository}. | +| treeSha | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/tree#tree_sha DataGithubTree#tree_sha}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/tree#id DataGithubTree#id}. | +| recursive | 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/tree#recursive DataGithubTree#recursive}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/tree#repository DataGithubTree#repository}. + +--- + +##### `treeSha`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/tree#tree_sha DataGithubTree#tree_sha}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/tree#id DataGithubTree#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. + +--- + +##### `recursive`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/tree#recursive DataGithubTree#recursive}. + +--- + +#### 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.* | +| resetRecursive | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetRecursive` + +```java +public void resetRecursive() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubTree resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_tree.DataGithubTree; + +DataGithubTree.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` + +```java +import io.cdktn.providers.github.data_github_tree.DataGithubTree; + +DataGithubTree.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_tree.DataGithubTree; + +DataGithubTree.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_tree.DataGithubTree; + +DataGithubTree.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubTree.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubTree 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 DataGithubTree to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubTree that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/tree#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 DataGithubTree 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| entries | DataGithubTreeEntriesList | *No description.* | +| idInput | java.lang.String | *No description.* | +| recursiveInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| treeShaInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| recursive | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| repository | java.lang.String | *No description.* | +| treeSha | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `entries`Required + +```java +public DataGithubTreeEntriesList getEntries(); +``` + +- *Type:* DataGithubTreeEntriesList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `recursiveInput`Optional + +```java +public java.lang.Boolean|IResolvable getRecursiveInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `treeShaInput`Optional + +```java +public java.lang.String getTreeShaInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `recursive`Required + +```java +public java.lang.Boolean|IResolvable getRecursive(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `treeSha`Required + +```java +public java.lang.String getTreeSha(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubTreeConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_tree.DataGithubTreeConfig; + +DataGithubTreeConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) + .treeSha(java.lang.String) +// .id(java.lang.String) +// .recursive(java.lang.Boolean|IResolvable) + .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 | *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 | *No description.* | +| repository | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/tree#repository DataGithubTree#repository}. | +| treeSha | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/tree#tree_sha DataGithubTree#tree_sha}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/tree#id DataGithubTree#id}. | +| recursive | 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/tree#recursive DataGithubTree#recursive}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/tree#repository DataGithubTree#repository}. + +--- + +##### `treeSha`Required + +```java +public java.lang.String getTreeSha(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/tree#tree_sha DataGithubTree#tree_sha}. + +--- + +##### `id`Optional + +```java +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/tree#id DataGithubTree#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. + +--- + +##### `recursive`Optional + +```java +public java.lang.Boolean|IResolvable getRecursive(); +``` + +- *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/tree#recursive DataGithubTree#recursive}. + +--- + +### DataGithubTreeEntries + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_tree.DataGithubTreeEntries; + +DataGithubTreeEntries.builder() + .build(); +``` + + +## Classes + +### DataGithubTreeEntriesList + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_tree.DataGithubTreeEntriesList; + +new DataGithubTreeEntriesList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public DataGithubTreeEntriesOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + + +### DataGithubTreeEntriesOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_tree.DataGithubTreeEntriesOutputReference; + +new DataGithubTreeEntriesOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| mode | java.lang.String | *No description.* | +| path | java.lang.String | *No description.* | +| sha | java.lang.String | *No description.* | +| size | java.lang.Number | *No description.* | +| type | java.lang.String | *No description.* | +| internalValue | DataGithubTreeEntries | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `mode`Required + +```java +public java.lang.String getMode(); +``` + +- *Type:* java.lang.String + +--- + +##### `path`Required + +```java +public java.lang.String getPath(); +``` + +- *Type:* java.lang.String + +--- + +##### `sha`Required + +```java +public java.lang.String getSha(); +``` + +- *Type:* java.lang.String + +--- + +##### `size`Required + +```java +public java.lang.Number getSize(); +``` + +- *Type:* java.lang.Number + +--- + +##### `type`Required + +```java +public java.lang.String getType(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public DataGithubTreeEntries getInternalValue(); +``` + +- *Type:* DataGithubTreeEntries + +--- + + + diff --git a/docs/dataGithubUser.csharp.md b/docs/dataGithubUser.csharp.md new file mode 100644 index 000000000..8bd392776 --- /dev/null +++ b/docs/dataGithubUser.csharp.md @@ -0,0 +1,968 @@ +# `dataGithubUser` Submodule + +## Constructs + +### DataGithubUser + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user github_user}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubUser(Construct Scope, string Id, DataGithubUserConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubUserConfig | *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:* DataGithubUserConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubUser resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubUser.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubUser.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubUser.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubUser.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubUser resource upon running "cdktn 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 DataGithubUser to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubUser that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubUser to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| AvatarUrl | string | *No description.* | +| Bio | string | *No description.* | +| Blog | string | *No description.* | +| Company | string | *No description.* | +| CreatedAt | string | *No description.* | +| Email | string | *No description.* | +| Followers | double | *No description.* | +| Following | double | *No description.* | +| GpgKeys | string[] | *No description.* | +| GravatarId | string | *No description.* | +| Location | string | *No description.* | +| Login | string | *No description.* | +| Name | string | *No description.* | +| NodeId | string | *No description.* | +| PublicGists | double | *No description.* | +| PublicRepos | double | *No description.* | +| SiteAdmin | Io.Cdktn.IResolvable | *No description.* | +| SshKeys | string[] | *No description.* | +| SuspendedAt | string | *No description.* | +| UpdatedAt | string | *No description.* | +| IdInput | string | *No description.* | +| UsernameInput | string | *No description.* | +| Id | string | *No description.* | +| Username | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `AvatarUrl`Required + +```csharp +public string AvatarUrl { get; } +``` + +- *Type:* string + +--- + +##### `Bio`Required + +```csharp +public string Bio { get; } +``` + +- *Type:* string + +--- + +##### `Blog`Required + +```csharp +public string Blog { get; } +``` + +- *Type:* string + +--- + +##### `Company`Required + +```csharp +public string Company { get; } +``` + +- *Type:* string + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Email`Required + +```csharp +public string Email { get; } +``` + +- *Type:* string + +--- + +##### `Followers`Required + +```csharp +public double Followers { get; } +``` + +- *Type:* double + +--- + +##### `Following`Required + +```csharp +public double Following { get; } +``` + +- *Type:* double + +--- + +##### `GpgKeys`Required + +```csharp +public string[] GpgKeys { get; } +``` + +- *Type:* string[] + +--- + +##### `GravatarId`Required + +```csharp +public string GravatarId { get; } +``` + +- *Type:* string + +--- + +##### `Location`Required + +```csharp +public string Location { get; } +``` + +- *Type:* string + +--- + +##### `Login`Required + +```csharp +public string Login { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `NodeId`Required + +```csharp +public string NodeId { get; } +``` + +- *Type:* string + +--- + +##### `PublicGists`Required + +```csharp +public double PublicGists { get; } +``` + +- *Type:* double + +--- + +##### `PublicRepos`Required + +```csharp +public double PublicRepos { get; } +``` + +- *Type:* double + +--- + +##### `SiteAdmin`Required + +```csharp +public IResolvable SiteAdmin { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `SshKeys`Required + +```csharp +public string[] SshKeys { get; } +``` + +- *Type:* string[] + +--- + +##### `SuspendedAt`Required + +```csharp +public string SuspendedAt { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `UsernameInput`Optional + +```csharp +public string UsernameInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Username`Required + +```csharp +public string Username { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubUserConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubUserConfig { + 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 Username, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Username | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user#username DataGithubUser#username}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user#id DataGithubUser#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Username`Required + +```csharp +public string Username { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user#username DataGithubUser#username}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user#id DataGithubUser#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. + +--- + + + diff --git a/docs/dataGithubUser.java.md b/docs/dataGithubUser.java.md new file mode 100644 index 000000000..80472613d --- /dev/null +++ b/docs/dataGithubUser.java.md @@ -0,0 +1,1041 @@ +# `dataGithubUser` Submodule + +## Constructs + +### DataGithubUser + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user github_user}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_user.DataGithubUser; + +DataGithubUser.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .username(java.lang.String) +// .id(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 | *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 | *No description.* | +| username | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user#username DataGithubUser#username}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user#id DataGithubUser#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `username`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user#username DataGithubUser#username}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user#id DataGithubUser#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubUser resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_user.DataGithubUser; + +DataGithubUser.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` + +```java +import io.cdktn.providers.github.data_github_user.DataGithubUser; + +DataGithubUser.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_user.DataGithubUser; + +DataGithubUser.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_user.DataGithubUser; + +DataGithubUser.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubUser.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubUser 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 DataGithubUser to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubUser that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user#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 DataGithubUser 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| avatarUrl | java.lang.String | *No description.* | +| bio | java.lang.String | *No description.* | +| blog | java.lang.String | *No description.* | +| company | java.lang.String | *No description.* | +| createdAt | java.lang.String | *No description.* | +| email | java.lang.String | *No description.* | +| followers | java.lang.Number | *No description.* | +| following | java.lang.Number | *No description.* | +| gpgKeys | java.util.List | *No description.* | +| gravatarId | java.lang.String | *No description.* | +| location | java.lang.String | *No description.* | +| login | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| nodeId | java.lang.String | *No description.* | +| publicGists | java.lang.Number | *No description.* | +| publicRepos | java.lang.Number | *No description.* | +| siteAdmin | io.cdktn.cdktn.IResolvable | *No description.* | +| sshKeys | java.util.List | *No description.* | +| suspendedAt | java.lang.String | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| usernameInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| username | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `avatarUrl`Required + +```java +public java.lang.String getAvatarUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `bio`Required + +```java +public java.lang.String getBio(); +``` + +- *Type:* java.lang.String + +--- + +##### `blog`Required + +```java +public java.lang.String getBlog(); +``` + +- *Type:* java.lang.String + +--- + +##### `company`Required + +```java +public java.lang.String getCompany(); +``` + +- *Type:* java.lang.String + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `email`Required + +```java +public java.lang.String getEmail(); +``` + +- *Type:* java.lang.String + +--- + +##### `followers`Required + +```java +public java.lang.Number getFollowers(); +``` + +- *Type:* java.lang.Number + +--- + +##### `following`Required + +```java +public java.lang.Number getFollowing(); +``` + +- *Type:* java.lang.Number + +--- + +##### `gpgKeys`Required + +```java +public java.util.List getGpgKeys(); +``` + +- *Type:* java.util.List + +--- + +##### `gravatarId`Required + +```java +public java.lang.String getGravatarId(); +``` + +- *Type:* java.lang.String + +--- + +##### `location`Required + +```java +public java.lang.String getLocation(); +``` + +- *Type:* java.lang.String + +--- + +##### `login`Required + +```java +public java.lang.String getLogin(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `nodeId`Required + +```java +public java.lang.String getNodeId(); +``` + +- *Type:* java.lang.String + +--- + +##### `publicGists`Required + +```java +public java.lang.Number getPublicGists(); +``` + +- *Type:* java.lang.Number + +--- + +##### `publicRepos`Required + +```java +public java.lang.Number getPublicRepos(); +``` + +- *Type:* java.lang.Number + +--- + +##### `siteAdmin`Required + +```java +public IResolvable getSiteAdmin(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `sshKeys`Required + +```java +public java.util.List getSshKeys(); +``` + +- *Type:* java.util.List + +--- + +##### `suspendedAt`Required + +```java +public java.lang.String getSuspendedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `usernameInput`Optional + +```java +public java.lang.String getUsernameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `username`Required + +```java +public java.lang.String getUsername(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubUserConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_user.DataGithubUserConfig; + +DataGithubUserConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .username(java.lang.String) +// .id(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 | *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 | *No description.* | +| username | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user#username DataGithubUser#username}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user#id DataGithubUser#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `username`Required + +```java +public java.lang.String getUsername(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user#username DataGithubUser#username}. + +--- + +##### `id`Optional + +```java +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/user#id DataGithubUser#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. + +--- + + + diff --git a/docs/dataGithubUserExternalIdentity.csharp.md b/docs/dataGithubUserExternalIdentity.csharp.md new file mode 100644 index 000000000..3d2a739a8 --- /dev/null +++ b/docs/dataGithubUserExternalIdentity.csharp.md @@ -0,0 +1,781 @@ +# `dataGithubUserExternalIdentity` Submodule + +## Constructs + +### DataGithubUserExternalIdentity + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user_external_identity github_user_external_identity}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubUserExternalIdentity(Construct Scope, string Id, DataGithubUserExternalIdentityConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubUserExternalIdentityConfig | *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:* DataGithubUserExternalIdentityConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubUserExternalIdentity resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubUserExternalIdentity.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubUserExternalIdentity.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubUserExternalIdentity.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubUserExternalIdentity.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubUserExternalIdentity resource upon running "cdktn 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 DataGithubUserExternalIdentity to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubUserExternalIdentity that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user_external_identity#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubUserExternalIdentity to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Login | string | *No description.* | +| SamlIdentity | Io.Cdktn.StringMap | *No description.* | +| ScimIdentity | Io.Cdktn.StringMap | *No description.* | +| IdInput | string | *No description.* | +| UsernameInput | string | *No description.* | +| Id | string | *No description.* | +| Username | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Login`Required + +```csharp +public string Login { get; } +``` + +- *Type:* string + +--- + +##### `SamlIdentity`Required + +```csharp +public StringMap SamlIdentity { get; } +``` + +- *Type:* Io.Cdktn.StringMap + +--- + +##### `ScimIdentity`Required + +```csharp +public StringMap ScimIdentity { get; } +``` + +- *Type:* Io.Cdktn.StringMap + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `UsernameInput`Optional + +```csharp +public string UsernameInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Username`Required + +```csharp +public string Username { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubUserExternalIdentityConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubUserExternalIdentityConfig { + 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 Username, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Username | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user_external_identity#username DataGithubUserExternalIdentity#username}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user_external_identity#id DataGithubUserExternalIdentity#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Username`Required + +```csharp +public string Username { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user_external_identity#username DataGithubUserExternalIdentity#username}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user_external_identity#id DataGithubUserExternalIdentity#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. + +--- + + + diff --git a/docs/dataGithubUserExternalIdentity.java.md b/docs/dataGithubUserExternalIdentity.java.md new file mode 100644 index 000000000..2286aeede --- /dev/null +++ b/docs/dataGithubUserExternalIdentity.java.md @@ -0,0 +1,854 @@ +# `dataGithubUserExternalIdentity` Submodule + +## Constructs + +### DataGithubUserExternalIdentity + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user_external_identity github_user_external_identity}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_user_external_identity.DataGithubUserExternalIdentity; + +DataGithubUserExternalIdentity.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .username(java.lang.String) +// .id(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 | *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 | *No description.* | +| username | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user_external_identity#username DataGithubUserExternalIdentity#username}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user_external_identity#id DataGithubUserExternalIdentity#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `username`Required + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user_external_identity#username DataGithubUserExternalIdentity#username}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user_external_identity#id DataGithubUserExternalIdentity#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubUserExternalIdentity resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_user_external_identity.DataGithubUserExternalIdentity; + +DataGithubUserExternalIdentity.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` + +```java +import io.cdktn.providers.github.data_github_user_external_identity.DataGithubUserExternalIdentity; + +DataGithubUserExternalIdentity.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_user_external_identity.DataGithubUserExternalIdentity; + +DataGithubUserExternalIdentity.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_user_external_identity.DataGithubUserExternalIdentity; + +DataGithubUserExternalIdentity.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubUserExternalIdentity.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubUserExternalIdentity 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 DataGithubUserExternalIdentity to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubUserExternalIdentity that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user_external_identity#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 DataGithubUserExternalIdentity 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| login | java.lang.String | *No description.* | +| samlIdentity | io.cdktn.cdktn.StringMap | *No description.* | +| scimIdentity | io.cdktn.cdktn.StringMap | *No description.* | +| idInput | java.lang.String | *No description.* | +| usernameInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| username | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `login`Required + +```java +public java.lang.String getLogin(); +``` + +- *Type:* java.lang.String + +--- + +##### `samlIdentity`Required + +```java +public StringMap getSamlIdentity(); +``` + +- *Type:* io.cdktn.cdktn.StringMap + +--- + +##### `scimIdentity`Required + +```java +public StringMap getScimIdentity(); +``` + +- *Type:* io.cdktn.cdktn.StringMap + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `usernameInput`Optional + +```java +public java.lang.String getUsernameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `username`Required + +```java +public java.lang.String getUsername(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubUserExternalIdentityConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_user_external_identity.DataGithubUserExternalIdentityConfig; + +DataGithubUserExternalIdentityConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .username(java.lang.String) +// .id(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 | *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 | *No description.* | +| username | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user_external_identity#username DataGithubUserExternalIdentity#username}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user_external_identity#id DataGithubUserExternalIdentity#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `username`Required + +```java +public java.lang.String getUsername(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/user_external_identity#username DataGithubUserExternalIdentity#username}. + +--- + +##### `id`Optional + +```java +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/user_external_identity#id DataGithubUserExternalIdentity#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. + +--- + + + diff --git a/docs/dataGithubUsers.csharp.md b/docs/dataGithubUsers.csharp.md new file mode 100644 index 000000000..8eadcd391 --- /dev/null +++ b/docs/dataGithubUsers.csharp.md @@ -0,0 +1,792 @@ +# `dataGithubUsers` Submodule + +## Constructs + +### DataGithubUsers + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/users github_users}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubUsers(Construct Scope, string Id, DataGithubUsersConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DataGithubUsersConfig | *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:* DataGithubUsersConfig + +--- + +#### 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.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformDataSource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DataGithubUsers resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubUsers.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubUsers.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformDataSource` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubUsers.IsTerraformDataSource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DataGithubUsers.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DataGithubUsers resource upon running "cdktn 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 DataGithubUsers to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DataGithubUsers that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/users#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DataGithubUsers to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Emails | string[] | *No description.* | +| Logins | string[] | *No description.* | +| NodeIds | string[] | *No description.* | +| UnknownLogins | string[] | *No description.* | +| IdInput | string | *No description.* | +| UsernamesInput | string[] | *No description.* | +| Id | string | *No description.* | +| Usernames | string[] | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Emails`Required + +```csharp +public string[] Emails { get; } +``` + +- *Type:* string[] + +--- + +##### `Logins`Required + +```csharp +public string[] Logins { get; } +``` + +- *Type:* string[] + +--- + +##### `NodeIds`Required + +```csharp +public string[] NodeIds { get; } +``` + +- *Type:* string[] + +--- + +##### `UnknownLogins`Required + +```csharp +public string[] UnknownLogins { get; } +``` + +- *Type:* string[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `UsernamesInput`Optional + +```csharp +public string[] UsernamesInput { get; } +``` + +- *Type:* string[] + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Usernames`Required + +```csharp +public string[] Usernames { get; } +``` + +- *Type:* string[] + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DataGithubUsersConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DataGithubUsersConfig { + 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[] Usernames, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Usernames | string[] | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/users#usernames DataGithubUsers#usernames}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/users#id DataGithubUsers#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Usernames`Required + +```csharp +public string[] Usernames { get; set; } +``` + +- *Type:* string[] + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/users#usernames DataGithubUsers#usernames}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/users#id DataGithubUsers#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. + +--- + + + diff --git a/docs/dataGithubUsers.java.md b/docs/dataGithubUsers.java.md new file mode 100644 index 000000000..3f3fec8e8 --- /dev/null +++ b/docs/dataGithubUsers.java.md @@ -0,0 +1,865 @@ +# `dataGithubUsers` Submodule + +## Constructs + +### DataGithubUsers + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/users github_users}. + +#### Initializers + +```java +import io.cdktn.providers.github.data_github_users.DataGithubUsers; + +DataGithubUsers.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .usernames(java.util.List) +// .id(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 | *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 | *No description.* | +| usernames | java.util.List | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/users#usernames DataGithubUsers#usernames}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/users#id DataGithubUsers#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `usernames`Required + +- *Type:* java.util.List + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/users#usernames DataGithubUsers#usernames}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/users#id DataGithubUsers#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. + +--- + +#### 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.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformDataSource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DataGithubUsers resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.data_github_users.DataGithubUsers; + +DataGithubUsers.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` + +```java +import io.cdktn.providers.github.data_github_users.DataGithubUsers; + +DataGithubUsers.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformDataSource` + +```java +import io.cdktn.providers.github.data_github_users.DataGithubUsers; + +DataGithubUsers.isTerraformDataSource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.data_github_users.DataGithubUsers; + +DataGithubUsers.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubUsers.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DataGithubUsers 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 DataGithubUsers to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DataGithubUsers that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/users#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 DataGithubUsers 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 | *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 | *No description.* | +| forEach | io.cdktn.cdktn.ITerraformIterator | *No description.* | +| lifecycle | io.cdktn.cdktn.TerraformResourceLifecycle | *No description.* | +| provider | io.cdktn.cdktn.TerraformProvider | *No description.* | +| emails | java.util.List | *No description.* | +| logins | java.util.List | *No description.* | +| nodeIds | java.util.List | *No description.* | +| unknownLogins | java.util.List | *No description.* | +| idInput | java.lang.String | *No description.* | +| usernamesInput | java.util.List | *No description.* | +| id | java.lang.String | *No description.* | +| usernames | java.util.List | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `emails`Required + +```java +public java.util.List getEmails(); +``` + +- *Type:* java.util.List + +--- + +##### `logins`Required + +```java +public java.util.List getLogins(); +``` + +- *Type:* java.util.List + +--- + +##### `nodeIds`Required + +```java +public java.util.List getNodeIds(); +``` + +- *Type:* java.util.List + +--- + +##### `unknownLogins`Required + +```java +public java.util.List getUnknownLogins(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `usernamesInput`Optional + +```java +public java.util.List getUsernamesInput(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `usernames`Required + +```java +public java.util.List getUsernames(); +``` + +- *Type:* java.util.List + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DataGithubUsersConfig + +#### Initializer + +```java +import io.cdktn.providers.github.data_github_users.DataGithubUsersConfig; + +DataGithubUsersConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .usernames(java.util.List) +// .id(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 | *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 | *No description.* | +| usernames | java.util.List | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/users#usernames DataGithubUsers#usernames}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/users#id DataGithubUsers#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `usernames`Required + +```java +public java.util.List getUsernames(); +``` + +- *Type:* java.util.List + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/users#usernames DataGithubUsers#usernames}. + +--- + +##### `id`Optional + +```java +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/users#id DataGithubUsers#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. + +--- + + + diff --git a/docs/dependabotOrganizationSecret.csharp.md b/docs/dependabotOrganizationSecret.csharp.md new file mode 100644 index 000000000..979d8b008 --- /dev/null +++ b/docs/dependabotOrganizationSecret.csharp.md @@ -0,0 +1,1217 @@ +# `dependabotOrganizationSecret` Submodule + +## Constructs + +### DependabotOrganizationSecret + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret github_dependabot_organization_secret}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DependabotOrganizationSecret(Construct Scope, string Id, DependabotOrganizationSecretConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DependabotOrganizationSecretConfig | *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:* DependabotOrganizationSecretConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetEncryptedValue | *No description.* | +| ResetId | *No description.* | +| ResetKeyId | *No description.* | +| ResetPlaintextValue | *No description.* | +| ResetSelectedRepositoryIds | *No description.* | +| ResetValue | *No description.* | +| ResetValueEncrypted | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetEncryptedValue` + +```csharp +private void ResetEncryptedValue() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetKeyId` + +```csharp +private void ResetKeyId() +``` + +##### `ResetPlaintextValue` + +```csharp +private void ResetPlaintextValue() +``` + +##### `ResetSelectedRepositoryIds` + +```csharp +private void ResetSelectedRepositoryIds() +``` + +##### `ResetValue` + +```csharp +private void ResetValue() +``` + +##### `ResetValueEncrypted` + +```csharp +private void ResetValueEncrypted() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DependabotOrganizationSecret resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DependabotOrganizationSecret.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DependabotOrganizationSecret.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +DependabotOrganizationSecret.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DependabotOrganizationSecret.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DependabotOrganizationSecret resource upon running "cdktn 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 DependabotOrganizationSecret to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DependabotOrganizationSecret that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DependabotOrganizationSecret to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| CreatedAt | string | *No description.* | +| RemoteUpdatedAt | string | *No description.* | +| UpdatedAt | string | *No description.* | +| EncryptedValueInput | string | *No description.* | +| IdInput | string | *No description.* | +| KeyIdInput | string | *No description.* | +| PlaintextValueInput | string | *No description.* | +| SecretNameInput | string | *No description.* | +| SelectedRepositoryIdsInput | double[] | *No description.* | +| ValueEncryptedInput | string | *No description.* | +| ValueInput | string | *No description.* | +| VisibilityInput | string | *No description.* | +| EncryptedValue | string | *No description.* | +| Id | string | *No description.* | +| KeyId | string | *No description.* | +| PlaintextValue | string | *No description.* | +| SecretName | string | *No description.* | +| SelectedRepositoryIds | double[] | *No description.* | +| Value | string | *No description.* | +| ValueEncrypted | string | *No description.* | +| Visibility | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `RemoteUpdatedAt`Required + +```csharp +public string RemoteUpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `EncryptedValueInput`Optional + +```csharp +public string EncryptedValueInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `KeyIdInput`Optional + +```csharp +public string KeyIdInput { get; } +``` + +- *Type:* string + +--- + +##### `PlaintextValueInput`Optional + +```csharp +public string PlaintextValueInput { get; } +``` + +- *Type:* string + +--- + +##### `SecretNameInput`Optional + +```csharp +public string SecretNameInput { get; } +``` + +- *Type:* string + +--- + +##### `SelectedRepositoryIdsInput`Optional + +```csharp +public double[] SelectedRepositoryIdsInput { get; } +``` + +- *Type:* double[] + +--- + +##### `ValueEncryptedInput`Optional + +```csharp +public string ValueEncryptedInput { get; } +``` + +- *Type:* string + +--- + +##### `ValueInput`Optional + +```csharp +public string ValueInput { get; } +``` + +- *Type:* string + +--- + +##### `VisibilityInput`Optional + +```csharp +public string VisibilityInput { get; } +``` + +- *Type:* string + +--- + +##### `EncryptedValue`Required + +```csharp +public string EncryptedValue { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `KeyId`Required + +```csharp +public string KeyId { get; } +``` + +- *Type:* string + +--- + +##### `PlaintextValue`Required + +```csharp +public string PlaintextValue { get; } +``` + +- *Type:* string + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; } +``` + +- *Type:* string + +--- + +##### `SelectedRepositoryIds`Required + +```csharp +public double[] SelectedRepositoryIds { get; } +``` + +- *Type:* double[] + +--- + +##### `Value`Required + +```csharp +public string Value { get; } +``` + +- *Type:* string + +--- + +##### `ValueEncrypted`Required + +```csharp +public string ValueEncrypted { get; } +``` + +- *Type:* string + +--- + +##### `Visibility`Required + +```csharp +public string Visibility { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DependabotOrganizationSecretConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DependabotOrganizationSecretConfig { + 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 SecretName, + string Visibility, + string EncryptedValue = null, + string Id = null, + string KeyId = null, + string PlaintextValue = null, + double[] SelectedRepositoryIds = null, + string Value = null, + string ValueEncrypted = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| SecretName | string | Name of the secret. | +| Visibility | string | Configures the access that repositories have to the organization secret. | +| EncryptedValue | string | Encrypted value of the secret using the GitHub public key in Base64 format. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#id DependabotOrganizationSecret#id}. | +| KeyId | string | ID of the public key used to encrypt the secret. | +| PlaintextValue | string | Plaintext value of the secret to be encrypted. | +| SelectedRepositoryIds | double[] | An array of repository ids that can access the organization secret. | +| Value | string | Plaintext value to be encrypted. | +| ValueEncrypted | string | Value encrypted with the GitHub public key, defined by key_id, in Base64 format. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; set; } +``` + +- *Type:* string + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#secret_name DependabotOrganizationSecret#secret_name} + +--- + +##### `Visibility`Required + +```csharp +public string Visibility { get; set; } +``` + +- *Type:* string + +Configures the access that repositories have to the organization secret. + +Must be one of 'all', 'private' or 'selected'. 'selected_repository_ids' is required if set to 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#visibility DependabotOrganizationSecret#visibility} + +--- + +##### `EncryptedValue`Optional + +```csharp +public string EncryptedValue { get; set; } +``` + +- *Type:* string + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#encrypted_value DependabotOrganizationSecret#encrypted_value} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#id DependabotOrganizationSecret#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. + +--- + +##### `KeyId`Optional + +```csharp +public string KeyId { get; set; } +``` + +- *Type:* string + +ID of the public key used to encrypt the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#key_id DependabotOrganizationSecret#key_id} + +--- + +##### `PlaintextValue`Optional + +```csharp +public string PlaintextValue { get; set; } +``` + +- *Type:* string + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#plaintext_value DependabotOrganizationSecret#plaintext_value} + +--- + +##### `SelectedRepositoryIds`Optional + +```csharp +public double[] SelectedRepositoryIds { get; set; } +``` + +- *Type:* double[] + +An array of repository ids that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#selected_repository_ids DependabotOrganizationSecret#selected_repository_ids} + +--- + +##### `Value`Optional + +```csharp +public string Value { get; set; } +``` + +- *Type:* string + +Plaintext value to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#value DependabotOrganizationSecret#value} + +--- + +##### `ValueEncrypted`Optional + +```csharp +public string ValueEncrypted { get; set; } +``` + +- *Type:* string + +Value encrypted with the GitHub public key, defined by key_id, in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#value_encrypted DependabotOrganizationSecret#value_encrypted} + +--- + + + diff --git a/docs/dependabotOrganizationSecret.java.md b/docs/dependabotOrganizationSecret.java.md new file mode 100644 index 000000000..d4ad097ba --- /dev/null +++ b/docs/dependabotOrganizationSecret.java.md @@ -0,0 +1,1380 @@ +# `dependabotOrganizationSecret` Submodule + +## Constructs + +### DependabotOrganizationSecret + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret github_dependabot_organization_secret}. + +#### Initializers + +```java +import io.cdktn.providers.github.dependabot_organization_secret.DependabotOrganizationSecret; + +DependabotOrganizationSecret.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .secretName(java.lang.String) + .visibility(java.lang.String) +// .encryptedValue(java.lang.String) +// .id(java.lang.String) +// .keyId(java.lang.String) +// .plaintextValue(java.lang.String) +// .selectedRepositoryIds(java.util.List) +// .value(java.lang.String) +// .valueEncrypted(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 | *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 | *No description.* | +| secretName | java.lang.String | Name of the secret. | +| visibility | java.lang.String | Configures the access that repositories have to the organization secret. | +| encryptedValue | java.lang.String | Encrypted value of the secret using the GitHub public key in Base64 format. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#id DependabotOrganizationSecret#id}. | +| keyId | java.lang.String | ID of the public key used to encrypt the secret. | +| plaintextValue | java.lang.String | Plaintext value of the secret to be encrypted. | +| selectedRepositoryIds | java.util.List | An array of repository ids that can access the organization secret. | +| value | java.lang.String | Plaintext value to be encrypted. | +| valueEncrypted | java.lang.String | Value encrypted with the GitHub public key, defined by key_id, in Base64 format. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `secretName`Required + +- *Type:* java.lang.String + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#secret_name DependabotOrganizationSecret#secret_name} + +--- + +##### `visibility`Required + +- *Type:* java.lang.String + +Configures the access that repositories have to the organization secret. + +Must be one of 'all', 'private' or 'selected'. 'selected_repository_ids' is required if set to 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#visibility DependabotOrganizationSecret#visibility} + +--- + +##### `encryptedValue`Optional + +- *Type:* java.lang.String + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#encrypted_value DependabotOrganizationSecret#encrypted_value} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#id DependabotOrganizationSecret#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. + +--- + +##### `keyId`Optional + +- *Type:* java.lang.String + +ID of the public key used to encrypt the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#key_id DependabotOrganizationSecret#key_id} + +--- + +##### `plaintextValue`Optional + +- *Type:* java.lang.String + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#plaintext_value DependabotOrganizationSecret#plaintext_value} + +--- + +##### `selectedRepositoryIds`Optional + +- *Type:* java.util.List + +An array of repository ids that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#selected_repository_ids DependabotOrganizationSecret#selected_repository_ids} + +--- + +##### `value`Optional + +- *Type:* java.lang.String + +Plaintext value to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#value DependabotOrganizationSecret#value} + +--- + +##### `valueEncrypted`Optional + +- *Type:* java.lang.String + +Value encrypted with the GitHub public key, defined by key_id, in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#value_encrypted DependabotOrganizationSecret#value_encrypted} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetEncryptedValue | *No description.* | +| resetId | *No description.* | +| resetKeyId | *No description.* | +| resetPlaintextValue | *No description.* | +| resetSelectedRepositoryIds | *No description.* | +| resetValue | *No description.* | +| resetValueEncrypted | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetEncryptedValue` + +```java +public void resetEncryptedValue() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetKeyId` + +```java +public void resetKeyId() +``` + +##### `resetPlaintextValue` + +```java +public void resetPlaintextValue() +``` + +##### `resetSelectedRepositoryIds` + +```java +public void resetSelectedRepositoryIds() +``` + +##### `resetValue` + +```java +public void resetValue() +``` + +##### `resetValueEncrypted` + +```java +public void resetValueEncrypted() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DependabotOrganizationSecret resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.dependabot_organization_secret.DependabotOrganizationSecret; + +DependabotOrganizationSecret.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` + +```java +import io.cdktn.providers.github.dependabot_organization_secret.DependabotOrganizationSecret; + +DependabotOrganizationSecret.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.dependabot_organization_secret.DependabotOrganizationSecret; + +DependabotOrganizationSecret.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.dependabot_organization_secret.DependabotOrganizationSecret; + +DependabotOrganizationSecret.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DependabotOrganizationSecret.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DependabotOrganizationSecret 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 DependabotOrganizationSecret to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DependabotOrganizationSecret that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#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 DependabotOrganizationSecret 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| createdAt | java.lang.String | *No description.* | +| remoteUpdatedAt | java.lang.String | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| encryptedValueInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| keyIdInput | java.lang.String | *No description.* | +| plaintextValueInput | java.lang.String | *No description.* | +| secretNameInput | java.lang.String | *No description.* | +| selectedRepositoryIdsInput | java.util.List | *No description.* | +| valueEncryptedInput | java.lang.String | *No description.* | +| valueInput | java.lang.String | *No description.* | +| visibilityInput | java.lang.String | *No description.* | +| encryptedValue | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| keyId | java.lang.String | *No description.* | +| plaintextValue | java.lang.String | *No description.* | +| secretName | java.lang.String | *No description.* | +| selectedRepositoryIds | java.util.List | *No description.* | +| value | java.lang.String | *No description.* | +| valueEncrypted | java.lang.String | *No description.* | +| visibility | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `remoteUpdatedAt`Required + +```java +public java.lang.String getRemoteUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `encryptedValueInput`Optional + +```java +public java.lang.String getEncryptedValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `keyIdInput`Optional + +```java +public java.lang.String getKeyIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `plaintextValueInput`Optional + +```java +public java.lang.String getPlaintextValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretNameInput`Optional + +```java +public java.lang.String getSecretNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `selectedRepositoryIdsInput`Optional + +```java +public java.util.List getSelectedRepositoryIdsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `valueEncryptedInput`Optional + +```java +public java.lang.String getValueEncryptedInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `valueInput`Optional + +```java +public java.lang.String getValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `visibilityInput`Optional + +```java +public java.lang.String getVisibilityInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `encryptedValue`Required + +```java +public java.lang.String getEncryptedValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `keyId`Required + +```java +public java.lang.String getKeyId(); +``` + +- *Type:* java.lang.String + +--- + +##### `plaintextValue`Required + +```java +public java.lang.String getPlaintextValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +--- + +##### `selectedRepositoryIds`Required + +```java +public java.util.List getSelectedRepositoryIds(); +``` + +- *Type:* java.util.List + +--- + +##### `value`Required + +```java +public java.lang.String getValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `valueEncrypted`Required + +```java +public java.lang.String getValueEncrypted(); +``` + +- *Type:* java.lang.String + +--- + +##### `visibility`Required + +```java +public java.lang.String getVisibility(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DependabotOrganizationSecretConfig + +#### Initializer + +```java +import io.cdktn.providers.github.dependabot_organization_secret.DependabotOrganizationSecretConfig; + +DependabotOrganizationSecretConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .secretName(java.lang.String) + .visibility(java.lang.String) +// .encryptedValue(java.lang.String) +// .id(java.lang.String) +// .keyId(java.lang.String) +// .plaintextValue(java.lang.String) +// .selectedRepositoryIds(java.util.List) +// .value(java.lang.String) +// .valueEncrypted(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 | *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 | *No description.* | +| secretName | java.lang.String | Name of the secret. | +| visibility | java.lang.String | Configures the access that repositories have to the organization secret. | +| encryptedValue | java.lang.String | Encrypted value of the secret using the GitHub public key in Base64 format. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#id DependabotOrganizationSecret#id}. | +| keyId | java.lang.String | ID of the public key used to encrypt the secret. | +| plaintextValue | java.lang.String | Plaintext value of the secret to be encrypted. | +| selectedRepositoryIds | java.util.List | An array of repository ids that can access the organization secret. | +| value | java.lang.String | Plaintext value to be encrypted. | +| valueEncrypted | java.lang.String | Value encrypted with the GitHub public key, defined by key_id, in Base64 format. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#secret_name DependabotOrganizationSecret#secret_name} + +--- + +##### `visibility`Required + +```java +public java.lang.String getVisibility(); +``` + +- *Type:* java.lang.String + +Configures the access that repositories have to the organization secret. + +Must be one of 'all', 'private' or 'selected'. 'selected_repository_ids' is required if set to 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#visibility DependabotOrganizationSecret#visibility} + +--- + +##### `encryptedValue`Optional + +```java +public java.lang.String getEncryptedValue(); +``` + +- *Type:* java.lang.String + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#encrypted_value DependabotOrganizationSecret#encrypted_value} + +--- + +##### `id`Optional + +```java +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/resources/dependabot_organization_secret#id DependabotOrganizationSecret#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. + +--- + +##### `keyId`Optional + +```java +public java.lang.String getKeyId(); +``` + +- *Type:* java.lang.String + +ID of the public key used to encrypt the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#key_id DependabotOrganizationSecret#key_id} + +--- + +##### `plaintextValue`Optional + +```java +public java.lang.String getPlaintextValue(); +``` + +- *Type:* java.lang.String + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#plaintext_value DependabotOrganizationSecret#plaintext_value} + +--- + +##### `selectedRepositoryIds`Optional + +```java +public java.util.List getSelectedRepositoryIds(); +``` + +- *Type:* java.util.List + +An array of repository ids that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#selected_repository_ids DependabotOrganizationSecret#selected_repository_ids} + +--- + +##### `value`Optional + +```java +public java.lang.String getValue(); +``` + +- *Type:* java.lang.String + +Plaintext value to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#value DependabotOrganizationSecret#value} + +--- + +##### `valueEncrypted`Optional + +```java +public java.lang.String getValueEncrypted(); +``` + +- *Type:* java.lang.String + +Value encrypted with the GitHub public key, defined by key_id, in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret#value_encrypted DependabotOrganizationSecret#value_encrypted} + +--- + + + diff --git a/docs/dependabotOrganizationSecretRepositories.csharp.md b/docs/dependabotOrganizationSecretRepositories.csharp.md new file mode 100644 index 000000000..150a70ca3 --- /dev/null +++ b/docs/dependabotOrganizationSecretRepositories.csharp.md @@ -0,0 +1,912 @@ +# `dependabotOrganizationSecretRepositories` Submodule + +## Constructs + +### DependabotOrganizationSecretRepositories + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repositories github_dependabot_organization_secret_repositories}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DependabotOrganizationSecretRepositories(Construct Scope, string Id, DependabotOrganizationSecretRepositoriesConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DependabotOrganizationSecretRepositoriesConfig | *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:* DependabotOrganizationSecretRepositoriesConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DependabotOrganizationSecretRepositories resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DependabotOrganizationSecretRepositories.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DependabotOrganizationSecretRepositories.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +DependabotOrganizationSecretRepositories.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DependabotOrganizationSecretRepositories.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DependabotOrganizationSecretRepositories resource upon running "cdktn 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 DependabotOrganizationSecretRepositories to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DependabotOrganizationSecretRepositories that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repositories#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DependabotOrganizationSecretRepositories to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| IdInput | string | *No description.* | +| SecretNameInput | string | *No description.* | +| SelectedRepositoryIdsInput | double[] | *No description.* | +| Id | string | *No description.* | +| SecretName | string | *No description.* | +| SelectedRepositoryIds | double[] | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `SecretNameInput`Optional + +```csharp +public string SecretNameInput { get; } +``` + +- *Type:* string + +--- + +##### `SelectedRepositoryIdsInput`Optional + +```csharp +public double[] SelectedRepositoryIdsInput { get; } +``` + +- *Type:* double[] + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; } +``` + +- *Type:* string + +--- + +##### `SelectedRepositoryIds`Required + +```csharp +public double[] SelectedRepositoryIds { get; } +``` + +- *Type:* double[] + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DependabotOrganizationSecretRepositoriesConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DependabotOrganizationSecretRepositoriesConfig { + 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 SecretName, + double[] SelectedRepositoryIds, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| SecretName | string | Name of the existing secret. | +| SelectedRepositoryIds | double[] | An array of repository ids that can access the organization secret. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repositories#id DependabotOrganizationSecretRepositories#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; set; } +``` + +- *Type:* string + +Name of the existing secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repositories#secret_name DependabotOrganizationSecretRepositories#secret_name} + +--- + +##### `SelectedRepositoryIds`Required + +```csharp +public double[] SelectedRepositoryIds { get; set; } +``` + +- *Type:* double[] + +An array of repository ids that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repositories#selected_repository_ids DependabotOrganizationSecretRepositories#selected_repository_ids} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repositories#id DependabotOrganizationSecretRepositories#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. + +--- + + + diff --git a/docs/dependabotOrganizationSecretRepositories.java.md b/docs/dependabotOrganizationSecretRepositories.java.md new file mode 100644 index 000000000..f7960b1e1 --- /dev/null +++ b/docs/dependabotOrganizationSecretRepositories.java.md @@ -0,0 +1,1001 @@ +# `dependabotOrganizationSecretRepositories` Submodule + +## Constructs + +### DependabotOrganizationSecretRepositories + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repositories github_dependabot_organization_secret_repositories}. + +#### Initializers + +```java +import io.cdktn.providers.github.dependabot_organization_secret_repositories.DependabotOrganizationSecretRepositories; + +DependabotOrganizationSecretRepositories.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .secretName(java.lang.String) + .selectedRepositoryIds(java.util.List) +// .id(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 | *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 | *No description.* | +| secretName | java.lang.String | Name of the existing secret. | +| selectedRepositoryIds | java.util.List | An array of repository ids that can access the organization secret. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repositories#id DependabotOrganizationSecretRepositories#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `secretName`Required + +- *Type:* java.lang.String + +Name of the existing secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repositories#secret_name DependabotOrganizationSecretRepositories#secret_name} + +--- + +##### `selectedRepositoryIds`Required + +- *Type:* java.util.List + +An array of repository ids that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repositories#selected_repository_ids DependabotOrganizationSecretRepositories#selected_repository_ids} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repositories#id DependabotOrganizationSecretRepositories#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DependabotOrganizationSecretRepositories resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.dependabot_organization_secret_repositories.DependabotOrganizationSecretRepositories; + +DependabotOrganizationSecretRepositories.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` + +```java +import io.cdktn.providers.github.dependabot_organization_secret_repositories.DependabotOrganizationSecretRepositories; + +DependabotOrganizationSecretRepositories.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.dependabot_organization_secret_repositories.DependabotOrganizationSecretRepositories; + +DependabotOrganizationSecretRepositories.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.dependabot_organization_secret_repositories.DependabotOrganizationSecretRepositories; + +DependabotOrganizationSecretRepositories.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DependabotOrganizationSecretRepositories.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DependabotOrganizationSecretRepositories 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 DependabotOrganizationSecretRepositories to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DependabotOrganizationSecretRepositories that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_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 DependabotOrganizationSecretRepositories 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| idInput | java.lang.String | *No description.* | +| secretNameInput | java.lang.String | *No description.* | +| selectedRepositoryIdsInput | java.util.List | *No description.* | +| id | java.lang.String | *No description.* | +| secretName | java.lang.String | *No description.* | +| selectedRepositoryIds | java.util.List | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretNameInput`Optional + +```java +public java.lang.String getSecretNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `selectedRepositoryIdsInput`Optional + +```java +public java.util.List getSelectedRepositoryIdsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +--- + +##### `selectedRepositoryIds`Required + +```java +public java.util.List getSelectedRepositoryIds(); +``` + +- *Type:* java.util.List + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DependabotOrganizationSecretRepositoriesConfig + +#### Initializer + +```java +import io.cdktn.providers.github.dependabot_organization_secret_repositories.DependabotOrganizationSecretRepositoriesConfig; + +DependabotOrganizationSecretRepositoriesConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .secretName(java.lang.String) + .selectedRepositoryIds(java.util.List) +// .id(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 | *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 | *No description.* | +| secretName | java.lang.String | Name of the existing secret. | +| selectedRepositoryIds | java.util.List | An array of repository ids that can access the organization secret. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repositories#id DependabotOrganizationSecretRepositories#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +Name of the existing secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repositories#secret_name DependabotOrganizationSecretRepositories#secret_name} + +--- + +##### `selectedRepositoryIds`Required + +```java +public java.util.List getSelectedRepositoryIds(); +``` + +- *Type:* java.util.List + +An array of repository ids that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repositories#selected_repository_ids DependabotOrganizationSecretRepositories#selected_repository_ids} + +--- + +##### `id`Optional + +```java +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/resources/dependabot_organization_secret_repositories#id DependabotOrganizationSecretRepositories#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. + +--- + + + diff --git a/docs/dependabotOrganizationSecretRepository.csharp.md b/docs/dependabotOrganizationSecretRepository.csharp.md new file mode 100644 index 000000000..bda17a051 --- /dev/null +++ b/docs/dependabotOrganizationSecretRepository.csharp.md @@ -0,0 +1,912 @@ +# `dependabotOrganizationSecretRepository` Submodule + +## Constructs + +### DependabotOrganizationSecretRepository + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repository github_dependabot_organization_secret_repository}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DependabotOrganizationSecretRepository(Construct Scope, string Id, DependabotOrganizationSecretRepositoryConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DependabotOrganizationSecretRepositoryConfig | *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:* DependabotOrganizationSecretRepositoryConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DependabotOrganizationSecretRepository resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DependabotOrganizationSecretRepository.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DependabotOrganizationSecretRepository.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +DependabotOrganizationSecretRepository.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DependabotOrganizationSecretRepository.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DependabotOrganizationSecretRepository resource upon running "cdktn 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 DependabotOrganizationSecretRepository to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DependabotOrganizationSecretRepository that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repository#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DependabotOrganizationSecretRepository to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| IdInput | string | *No description.* | +| RepositoryIdInput | double | *No description.* | +| SecretNameInput | string | *No description.* | +| Id | string | *No description.* | +| RepositoryId | double | *No description.* | +| SecretName | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryIdInput`Optional + +```csharp +public double RepositoryIdInput { get; } +``` + +- *Type:* double + +--- + +##### `SecretNameInput`Optional + +```csharp +public string SecretNameInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryId`Required + +```csharp +public double RepositoryId { get; } +``` + +- *Type:* double + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DependabotOrganizationSecretRepositoryConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DependabotOrganizationSecretRepositoryConfig { + 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, + double RepositoryId, + string SecretName, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| RepositoryId | double | The repository ID that can access the organization secret. | +| SecretName | string | Name of the existing secret. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repository#id DependabotOrganizationSecretRepository#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `RepositoryId`Required + +```csharp +public double RepositoryId { get; set; } +``` + +- *Type:* double + +The repository ID that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repository#repository_id DependabotOrganizationSecretRepository#repository_id} + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; set; } +``` + +- *Type:* string + +Name of the existing secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repository#secret_name DependabotOrganizationSecretRepository#secret_name} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repository#id DependabotOrganizationSecretRepository#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. + +--- + + + diff --git a/docs/dependabotOrganizationSecretRepository.java.md b/docs/dependabotOrganizationSecretRepository.java.md new file mode 100644 index 000000000..17c38bd2e --- /dev/null +++ b/docs/dependabotOrganizationSecretRepository.java.md @@ -0,0 +1,1001 @@ +# `dependabotOrganizationSecretRepository` Submodule + +## Constructs + +### DependabotOrganizationSecretRepository + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repository github_dependabot_organization_secret_repository}. + +#### Initializers + +```java +import io.cdktn.providers.github.dependabot_organization_secret_repository.DependabotOrganizationSecretRepository; + +DependabotOrganizationSecretRepository.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repositoryId(java.lang.Number) + .secretName(java.lang.String) +// .id(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 | *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 | *No description.* | +| repositoryId | java.lang.Number | The repository ID that can access the organization secret. | +| secretName | java.lang.String | Name of the existing secret. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repository#id DependabotOrganizationSecretRepository#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repositoryId`Required + +- *Type:* java.lang.Number + +The repository ID that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repository#repository_id DependabotOrganizationSecretRepository#repository_id} + +--- + +##### `secretName`Required + +- *Type:* java.lang.String + +Name of the existing secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repository#secret_name DependabotOrganizationSecretRepository#secret_name} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repository#id DependabotOrganizationSecretRepository#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DependabotOrganizationSecretRepository resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.dependabot_organization_secret_repository.DependabotOrganizationSecretRepository; + +DependabotOrganizationSecretRepository.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` + +```java +import io.cdktn.providers.github.dependabot_organization_secret_repository.DependabotOrganizationSecretRepository; + +DependabotOrganizationSecretRepository.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.dependabot_organization_secret_repository.DependabotOrganizationSecretRepository; + +DependabotOrganizationSecretRepository.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.dependabot_organization_secret_repository.DependabotOrganizationSecretRepository; + +DependabotOrganizationSecretRepository.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DependabotOrganizationSecretRepository.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DependabotOrganizationSecretRepository 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 DependabotOrganizationSecretRepository to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DependabotOrganizationSecretRepository that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repository#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 DependabotOrganizationSecretRepository 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryIdInput | java.lang.Number | *No description.* | +| secretNameInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repositoryId | java.lang.Number | *No description.* | +| secretName | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryIdInput`Optional + +```java +public java.lang.Number getRepositoryIdInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `secretNameInput`Optional + +```java +public java.lang.String getSecretNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryId`Required + +```java +public java.lang.Number getRepositoryId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DependabotOrganizationSecretRepositoryConfig + +#### Initializer + +```java +import io.cdktn.providers.github.dependabot_organization_secret_repository.DependabotOrganizationSecretRepositoryConfig; + +DependabotOrganizationSecretRepositoryConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repositoryId(java.lang.Number) + .secretName(java.lang.String) +// .id(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 | *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 | *No description.* | +| repositoryId | java.lang.Number | The repository ID that can access the organization secret. | +| secretName | java.lang.String | Name of the existing secret. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repository#id DependabotOrganizationSecretRepository#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repositoryId`Required + +```java +public java.lang.Number getRepositoryId(); +``` + +- *Type:* java.lang.Number + +The repository ID that can access the organization secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repository#repository_id DependabotOrganizationSecretRepository#repository_id} + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +Name of the existing secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_organization_secret_repository#secret_name DependabotOrganizationSecretRepository#secret_name} + +--- + +##### `id`Optional + +```java +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/resources/dependabot_organization_secret_repository#id DependabotOrganizationSecretRepository#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. + +--- + + + diff --git a/docs/dependabotSecret.csharp.md b/docs/dependabotSecret.csharp.md new file mode 100644 index 000000000..2f8312d79 --- /dev/null +++ b/docs/dependabotSecret.csharp.md @@ -0,0 +1,1181 @@ +# `dependabotSecret` Submodule + +## Constructs + +### DependabotSecret + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret github_dependabot_secret}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new DependabotSecret(Construct Scope, string Id, DependabotSecretConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | DependabotSecretConfig | *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:* DependabotSecretConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetEncryptedValue | *No description.* | +| ResetId | *No description.* | +| ResetKeyId | *No description.* | +| ResetPlaintextValue | *No description.* | +| ResetValue | *No description.* | +| ResetValueEncrypted | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetEncryptedValue` + +```csharp +private void ResetEncryptedValue() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetKeyId` + +```csharp +private void ResetKeyId() +``` + +##### `ResetPlaintextValue` + +```csharp +private void ResetPlaintextValue() +``` + +##### `ResetValue` + +```csharp +private void ResetValue() +``` + +##### `ResetValueEncrypted` + +```csharp +private void ResetValueEncrypted() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a DependabotSecret resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +DependabotSecret.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` + +```csharp +using Io.Cdktn.Providers.Github; + +DependabotSecret.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +DependabotSecret.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +DependabotSecret.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a DependabotSecret resource upon running "cdktn 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 DependabotSecret to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing DependabotSecret that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the DependabotSecret to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| CreatedAt | string | *No description.* | +| RemoteUpdatedAt | string | *No description.* | +| RepositoryId | double | *No description.* | +| UpdatedAt | string | *No description.* | +| EncryptedValueInput | string | *No description.* | +| IdInput | string | *No description.* | +| KeyIdInput | string | *No description.* | +| PlaintextValueInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| SecretNameInput | string | *No description.* | +| ValueEncryptedInput | string | *No description.* | +| ValueInput | string | *No description.* | +| EncryptedValue | string | *No description.* | +| Id | string | *No description.* | +| KeyId | string | *No description.* | +| PlaintextValue | string | *No description.* | +| Repository | string | *No description.* | +| SecretName | string | *No description.* | +| Value | string | *No description.* | +| ValueEncrypted | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `RemoteUpdatedAt`Required + +```csharp +public string RemoteUpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryId`Required + +```csharp +public double RepositoryId { get; } +``` + +- *Type:* double + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `EncryptedValueInput`Optional + +```csharp +public string EncryptedValueInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `KeyIdInput`Optional + +```csharp +public string KeyIdInput { get; } +``` + +- *Type:* string + +--- + +##### `PlaintextValueInput`Optional + +```csharp +public string PlaintextValueInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `SecretNameInput`Optional + +```csharp +public string SecretNameInput { get; } +``` + +- *Type:* string + +--- + +##### `ValueEncryptedInput`Optional + +```csharp +public string ValueEncryptedInput { get; } +``` + +- *Type:* string + +--- + +##### `ValueInput`Optional + +```csharp +public string ValueInput { get; } +``` + +- *Type:* string + +--- + +##### `EncryptedValue`Required + +```csharp +public string EncryptedValue { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `KeyId`Required + +```csharp +public string KeyId { get; } +``` + +- *Type:* string + +--- + +##### `PlaintextValue`Required + +```csharp +public string PlaintextValue { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; } +``` + +- *Type:* string + +--- + +##### `Value`Required + +```csharp +public string Value { get; } +``` + +- *Type:* string + +--- + +##### `ValueEncrypted`Required + +```csharp +public string ValueEncrypted { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### DependabotSecretConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new DependabotSecretConfig { + 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 Repository, + string SecretName, + string EncryptedValue = null, + string Id = null, + string KeyId = null, + string PlaintextValue = null, + string Value = null, + string ValueEncrypted = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | Name of the repository. | +| SecretName | string | Name of the secret. | +| EncryptedValue | string | Encrypted value of the secret using the GitHub public key in Base64 format. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#id DependabotSecret#id}. | +| KeyId | string | ID of the public key used to encrypt the secret. | +| PlaintextValue | string | Plaintext value of the secret to be encrypted. | +| Value | string | Plaintext value to be encrypted. | +| ValueEncrypted | string | Value encrypted with the GitHub public key, defined by key_id, in Base64 format. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#repository DependabotSecret#repository} + +--- + +##### `SecretName`Required + +```csharp +public string SecretName { get; set; } +``` + +- *Type:* string + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#secret_name DependabotSecret#secret_name} + +--- + +##### `EncryptedValue`Optional + +```csharp +public string EncryptedValue { get; set; } +``` + +- *Type:* string + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#encrypted_value DependabotSecret#encrypted_value} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#id DependabotSecret#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. + +--- + +##### `KeyId`Optional + +```csharp +public string KeyId { get; set; } +``` + +- *Type:* string + +ID of the public key used to encrypt the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#key_id DependabotSecret#key_id} + +--- + +##### `PlaintextValue`Optional + +```csharp +public string PlaintextValue { get; set; } +``` + +- *Type:* string + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#plaintext_value DependabotSecret#plaintext_value} + +--- + +##### `Value`Optional + +```csharp +public string Value { get; set; } +``` + +- *Type:* string + +Plaintext value to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#value DependabotSecret#value} + +--- + +##### `ValueEncrypted`Optional + +```csharp +public string ValueEncrypted { get; set; } +``` + +- *Type:* string + +Value encrypted with the GitHub public key, defined by key_id, in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#value_encrypted DependabotSecret#value_encrypted} + +--- + + + diff --git a/docs/dependabotSecret.java.md b/docs/dependabotSecret.java.md new file mode 100644 index 000000000..ae52ac6f9 --- /dev/null +++ b/docs/dependabotSecret.java.md @@ -0,0 +1,1330 @@ +# `dependabotSecret` Submodule + +## Constructs + +### DependabotSecret + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret github_dependabot_secret}. + +#### Initializers + +```java +import io.cdktn.providers.github.dependabot_secret.DependabotSecret; + +DependabotSecret.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) + .secretName(java.lang.String) +// .encryptedValue(java.lang.String) +// .id(java.lang.String) +// .keyId(java.lang.String) +// .plaintextValue(java.lang.String) +// .value(java.lang.String) +// .valueEncrypted(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 | *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 | *No description.* | +| repository | java.lang.String | Name of the repository. | +| secretName | java.lang.String | Name of the secret. | +| encryptedValue | java.lang.String | Encrypted value of the secret using the GitHub public key in Base64 format. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#id DependabotSecret#id}. | +| keyId | java.lang.String | ID of the public key used to encrypt the secret. | +| plaintextValue | java.lang.String | Plaintext value of the secret to be encrypted. | +| value | java.lang.String | Plaintext value to be encrypted. | +| valueEncrypted | java.lang.String | Value encrypted with the GitHub public key, defined by key_id, in Base64 format. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#repository DependabotSecret#repository} + +--- + +##### `secretName`Required + +- *Type:* java.lang.String + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#secret_name DependabotSecret#secret_name} + +--- + +##### `encryptedValue`Optional + +- *Type:* java.lang.String + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#encrypted_value DependabotSecret#encrypted_value} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#id DependabotSecret#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. + +--- + +##### `keyId`Optional + +- *Type:* java.lang.String + +ID of the public key used to encrypt the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#key_id DependabotSecret#key_id} + +--- + +##### `plaintextValue`Optional + +- *Type:* java.lang.String + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#plaintext_value DependabotSecret#plaintext_value} + +--- + +##### `value`Optional + +- *Type:* java.lang.String + +Plaintext value to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#value DependabotSecret#value} + +--- + +##### `valueEncrypted`Optional + +- *Type:* java.lang.String + +Value encrypted with the GitHub public key, defined by key_id, in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#value_encrypted DependabotSecret#value_encrypted} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetEncryptedValue | *No description.* | +| resetId | *No description.* | +| resetKeyId | *No description.* | +| resetPlaintextValue | *No description.* | +| resetValue | *No description.* | +| resetValueEncrypted | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetEncryptedValue` + +```java +public void resetEncryptedValue() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetKeyId` + +```java +public void resetKeyId() +``` + +##### `resetPlaintextValue` + +```java +public void resetPlaintextValue() +``` + +##### `resetValue` + +```java +public void resetValue() +``` + +##### `resetValueEncrypted` + +```java +public void resetValueEncrypted() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a DependabotSecret resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.dependabot_secret.DependabotSecret; + +DependabotSecret.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` + +```java +import io.cdktn.providers.github.dependabot_secret.DependabotSecret; + +DependabotSecret.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.dependabot_secret.DependabotSecret; + +DependabotSecret.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.dependabot_secret.DependabotSecret; + +DependabotSecret.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DependabotSecret.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a DependabotSecret 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 DependabotSecret to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing DependabotSecret that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#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 DependabotSecret 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| createdAt | java.lang.String | *No description.* | +| remoteUpdatedAt | java.lang.String | *No description.* | +| repositoryId | java.lang.Number | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| encryptedValueInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| keyIdInput | java.lang.String | *No description.* | +| plaintextValueInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| secretNameInput | java.lang.String | *No description.* | +| valueEncryptedInput | java.lang.String | *No description.* | +| valueInput | java.lang.String | *No description.* | +| encryptedValue | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| keyId | java.lang.String | *No description.* | +| plaintextValue | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | +| secretName | java.lang.String | *No description.* | +| value | java.lang.String | *No description.* | +| valueEncrypted | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `remoteUpdatedAt`Required + +```java +public java.lang.String getRemoteUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryId`Required + +```java +public java.lang.Number getRepositoryId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `encryptedValueInput`Optional + +```java +public java.lang.String getEncryptedValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `keyIdInput`Optional + +```java +public java.lang.String getKeyIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `plaintextValueInput`Optional + +```java +public java.lang.String getPlaintextValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretNameInput`Optional + +```java +public java.lang.String getSecretNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `valueEncryptedInput`Optional + +```java +public java.lang.String getValueEncryptedInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `valueInput`Optional + +```java +public java.lang.String getValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `encryptedValue`Required + +```java +public java.lang.String getEncryptedValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `keyId`Required + +```java +public java.lang.String getKeyId(); +``` + +- *Type:* java.lang.String + +--- + +##### `plaintextValue`Required + +```java +public java.lang.String getPlaintextValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +--- + +##### `value`Required + +```java +public java.lang.String getValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `valueEncrypted`Required + +```java +public java.lang.String getValueEncrypted(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### DependabotSecretConfig + +#### Initializer + +```java +import io.cdktn.providers.github.dependabot_secret.DependabotSecretConfig; + +DependabotSecretConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) + .secretName(java.lang.String) +// .encryptedValue(java.lang.String) +// .id(java.lang.String) +// .keyId(java.lang.String) +// .plaintextValue(java.lang.String) +// .value(java.lang.String) +// .valueEncrypted(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 | *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 | *No description.* | +| repository | java.lang.String | Name of the repository. | +| secretName | java.lang.String | Name of the secret. | +| encryptedValue | java.lang.String | Encrypted value of the secret using the GitHub public key in Base64 format. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#id DependabotSecret#id}. | +| keyId | java.lang.String | ID of the public key used to encrypt the secret. | +| plaintextValue | java.lang.String | Plaintext value of the secret to be encrypted. | +| value | java.lang.String | Plaintext value to be encrypted. | +| valueEncrypted | java.lang.String | Value encrypted with the GitHub public key, defined by key_id, in Base64 format. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#repository DependabotSecret#repository} + +--- + +##### `secretName`Required + +```java +public java.lang.String getSecretName(); +``` + +- *Type:* java.lang.String + +Name of the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#secret_name DependabotSecret#secret_name} + +--- + +##### `encryptedValue`Optional + +```java +public java.lang.String getEncryptedValue(); +``` + +- *Type:* java.lang.String + +Encrypted value of the secret using the GitHub public key in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#encrypted_value DependabotSecret#encrypted_value} + +--- + +##### `id`Optional + +```java +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/resources/dependabot_secret#id DependabotSecret#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. + +--- + +##### `keyId`Optional + +```java +public java.lang.String getKeyId(); +``` + +- *Type:* java.lang.String + +ID of the public key used to encrypt the secret. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#key_id DependabotSecret#key_id} + +--- + +##### `plaintextValue`Optional + +```java +public java.lang.String getPlaintextValue(); +``` + +- *Type:* java.lang.String + +Plaintext value of the secret to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#plaintext_value DependabotSecret#plaintext_value} + +--- + +##### `value`Optional + +```java +public java.lang.String getValue(); +``` + +- *Type:* java.lang.String + +Plaintext value to be encrypted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#value DependabotSecret#value} + +--- + +##### `valueEncrypted`Optional + +```java +public java.lang.String getValueEncrypted(); +``` + +- *Type:* java.lang.String + +Value encrypted with the GitHub public key, defined by key_id, in Base64 format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/dependabot_secret#value_encrypted DependabotSecret#value_encrypted} + +--- + + + diff --git a/docs/emuGroupMapping.csharp.md b/docs/emuGroupMapping.csharp.md new file mode 100644 index 000000000..59cff35ae --- /dev/null +++ b/docs/emuGroupMapping.csharp.md @@ -0,0 +1,945 @@ +# `emuGroupMapping` Submodule + +## Constructs + +### EmuGroupMapping + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/emu_group_mapping github_emu_group_mapping}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new EmuGroupMapping(Construct Scope, string Id, EmuGroupMappingConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | EmuGroupMappingConfig | *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:* EmuGroupMappingConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a EmuGroupMapping resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +EmuGroupMapping.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` + +```csharp +using Io.Cdktn.Providers.Github; + +EmuGroupMapping.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +EmuGroupMapping.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +EmuGroupMapping.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a EmuGroupMapping resource upon running "cdktn 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 EmuGroupMapping to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing EmuGroupMapping that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/emu_group_mapping#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the EmuGroupMapping to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Etag | string | *No description.* | +| GroupName | string | *No description.* | +| TeamId | double | *No description.* | +| GroupIdInput | double | *No description.* | +| IdInput | string | *No description.* | +| TeamSlugInput | string | *No description.* | +| GroupId | double | *No description.* | +| Id | string | *No description.* | +| TeamSlug | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `GroupName`Required + +```csharp +public string GroupName { get; } +``` + +- *Type:* string + +--- + +##### `TeamId`Required + +```csharp +public double TeamId { get; } +``` + +- *Type:* double + +--- + +##### `GroupIdInput`Optional + +```csharp +public double GroupIdInput { get; } +``` + +- *Type:* double + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `TeamSlugInput`Optional + +```csharp +public string TeamSlugInput { get; } +``` + +- *Type:* string + +--- + +##### `GroupId`Required + +```csharp +public double GroupId { get; } +``` + +- *Type:* double + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `TeamSlug`Required + +```csharp +public string TeamSlug { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### EmuGroupMappingConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new EmuGroupMappingConfig { + 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, + double GroupId, + string TeamSlug, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| GroupId | double | Integer corresponding to the external group ID to be linked. | +| TeamSlug | string | Slug of the GitHub team. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/emu_group_mapping#id EmuGroupMapping#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `GroupId`Required + +```csharp +public double GroupId { get; set; } +``` + +- *Type:* double + +Integer corresponding to the external group ID to be linked. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/emu_group_mapping#group_id EmuGroupMapping#group_id} + +--- + +##### `TeamSlug`Required + +```csharp +public string TeamSlug { get; set; } +``` + +- *Type:* string + +Slug of the GitHub team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/emu_group_mapping#team_slug EmuGroupMapping#team_slug} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/emu_group_mapping#id EmuGroupMapping#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. + +--- + + + diff --git a/docs/emuGroupMapping.java.md b/docs/emuGroupMapping.java.md new file mode 100644 index 000000000..44e138f5a --- /dev/null +++ b/docs/emuGroupMapping.java.md @@ -0,0 +1,1034 @@ +# `emuGroupMapping` Submodule + +## Constructs + +### EmuGroupMapping + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/emu_group_mapping github_emu_group_mapping}. + +#### Initializers + +```java +import io.cdktn.providers.github.emu_group_mapping.EmuGroupMapping; + +EmuGroupMapping.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .groupId(java.lang.Number) + .teamSlug(java.lang.String) +// .id(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 | *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 | *No description.* | +| groupId | java.lang.Number | Integer corresponding to the external group ID to be linked. | +| teamSlug | java.lang.String | Slug of the GitHub team. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/emu_group_mapping#id EmuGroupMapping#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `groupId`Required + +- *Type:* java.lang.Number + +Integer corresponding to the external group ID to be linked. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/emu_group_mapping#group_id EmuGroupMapping#group_id} + +--- + +##### `teamSlug`Required + +- *Type:* java.lang.String + +Slug of the GitHub team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/emu_group_mapping#team_slug EmuGroupMapping#team_slug} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/emu_group_mapping#id EmuGroupMapping#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a EmuGroupMapping resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.emu_group_mapping.EmuGroupMapping; + +EmuGroupMapping.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` + +```java +import io.cdktn.providers.github.emu_group_mapping.EmuGroupMapping; + +EmuGroupMapping.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.emu_group_mapping.EmuGroupMapping; + +EmuGroupMapping.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.emu_group_mapping.EmuGroupMapping; + +EmuGroupMapping.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),EmuGroupMapping.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a EmuGroupMapping 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 EmuGroupMapping to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing EmuGroupMapping that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/emu_group_mapping#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 EmuGroupMapping 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| etag | java.lang.String | *No description.* | +| groupName | java.lang.String | *No description.* | +| teamId | java.lang.Number | *No description.* | +| groupIdInput | java.lang.Number | *No description.* | +| idInput | java.lang.String | *No description.* | +| teamSlugInput | java.lang.String | *No description.* | +| groupId | java.lang.Number | *No description.* | +| id | java.lang.String | *No description.* | +| teamSlug | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `groupName`Required + +```java +public java.lang.String getGroupName(); +``` + +- *Type:* java.lang.String + +--- + +##### `teamId`Required + +```java +public java.lang.Number getTeamId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `groupIdInput`Optional + +```java +public java.lang.Number getGroupIdInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `teamSlugInput`Optional + +```java +public java.lang.String getTeamSlugInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `groupId`Required + +```java +public java.lang.Number getGroupId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `teamSlug`Required + +```java +public java.lang.String getTeamSlug(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### EmuGroupMappingConfig + +#### Initializer + +```java +import io.cdktn.providers.github.emu_group_mapping.EmuGroupMappingConfig; + +EmuGroupMappingConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .groupId(java.lang.Number) + .teamSlug(java.lang.String) +// .id(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 | *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 | *No description.* | +| groupId | java.lang.Number | Integer corresponding to the external group ID to be linked. | +| teamSlug | java.lang.String | Slug of the GitHub team. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/emu_group_mapping#id EmuGroupMapping#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `groupId`Required + +```java +public java.lang.Number getGroupId(); +``` + +- *Type:* java.lang.Number + +Integer corresponding to the external group ID to be linked. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/emu_group_mapping#group_id EmuGroupMapping#group_id} + +--- + +##### `teamSlug`Required + +```java +public java.lang.String getTeamSlug(); +``` + +- *Type:* java.lang.String + +Slug of the GitHub team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/emu_group_mapping#team_slug EmuGroupMapping#team_slug} + +--- + +##### `id`Optional + +```java +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/resources/emu_group_mapping#id EmuGroupMapping#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. + +--- + + + diff --git a/docs/enterpriseActionsPermissions.csharp.md b/docs/enterpriseActionsPermissions.csharp.md new file mode 100644 index 000000000..f97c8c633 --- /dev/null +++ b/docs/enterpriseActionsPermissions.csharp.md @@ -0,0 +1,1782 @@ +# `enterpriseActionsPermissions` Submodule + +## Constructs + +### EnterpriseActionsPermissions + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions github_enterprise_actions_permissions}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new EnterpriseActionsPermissions(Construct Scope, string Id, EnterpriseActionsPermissionsConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | EnterpriseActionsPermissionsConfig | *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:* EnterpriseActionsPermissionsConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| PutAllowedActionsConfig | *No description.* | +| PutEnabledOrganizationsConfig | *No description.* | +| ResetAllowedActions | *No description.* | +| ResetAllowedActionsConfig | *No description.* | +| ResetEnabledOrganizationsConfig | *No description.* | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `PutAllowedActionsConfig` + +```csharp +private void PutAllowedActionsConfig(EnterpriseActionsPermissionsAllowedActionsConfig Value) +``` + +###### `Value`Required + +- *Type:* EnterpriseActionsPermissionsAllowedActionsConfig + +--- + +##### `PutEnabledOrganizationsConfig` + +```csharp +private void PutEnabledOrganizationsConfig(EnterpriseActionsPermissionsEnabledOrganizationsConfig Value) +``` + +###### `Value`Required + +- *Type:* EnterpriseActionsPermissionsEnabledOrganizationsConfig + +--- + +##### `ResetAllowedActions` + +```csharp +private void ResetAllowedActions() +``` + +##### `ResetAllowedActionsConfig` + +```csharp +private void ResetAllowedActionsConfig() +``` + +##### `ResetEnabledOrganizationsConfig` + +```csharp +private void ResetEnabledOrganizationsConfig() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a EnterpriseActionsPermissions resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseActionsPermissions.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` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseActionsPermissions.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseActionsPermissions.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseActionsPermissions.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a EnterpriseActionsPermissions resource upon running "cdktn 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 EnterpriseActionsPermissions to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing EnterpriseActionsPermissions that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the EnterpriseActionsPermissions to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| AllowedActionsConfig | EnterpriseActionsPermissionsAllowedActionsConfigOutputReference | *No description.* | +| EnabledOrganizationsConfig | EnterpriseActionsPermissionsEnabledOrganizationsConfigOutputReference | *No description.* | +| AllowedActionsConfigInput | EnterpriseActionsPermissionsAllowedActionsConfig | *No description.* | +| AllowedActionsInput | string | *No description.* | +| EnabledOrganizationsConfigInput | EnterpriseActionsPermissionsEnabledOrganizationsConfig | *No description.* | +| EnabledOrganizationsInput | string | *No description.* | +| EnterpriseSlugInput | string | *No description.* | +| IdInput | string | *No description.* | +| AllowedActions | string | *No description.* | +| EnabledOrganizations | string | *No description.* | +| EnterpriseSlug | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `AllowedActionsConfig`Required + +```csharp +public EnterpriseActionsPermissionsAllowedActionsConfigOutputReference AllowedActionsConfig { get; } +``` + +- *Type:* EnterpriseActionsPermissionsAllowedActionsConfigOutputReference + +--- + +##### `EnabledOrganizationsConfig`Required + +```csharp +public EnterpriseActionsPermissionsEnabledOrganizationsConfigOutputReference EnabledOrganizationsConfig { get; } +``` + +- *Type:* EnterpriseActionsPermissionsEnabledOrganizationsConfigOutputReference + +--- + +##### `AllowedActionsConfigInput`Optional + +```csharp +public EnterpriseActionsPermissionsAllowedActionsConfig AllowedActionsConfigInput { get; } +``` + +- *Type:* EnterpriseActionsPermissionsAllowedActionsConfig + +--- + +##### `AllowedActionsInput`Optional + +```csharp +public string AllowedActionsInput { get; } +``` + +- *Type:* string + +--- + +##### `EnabledOrganizationsConfigInput`Optional + +```csharp +public EnterpriseActionsPermissionsEnabledOrganizationsConfig EnabledOrganizationsConfigInput { get; } +``` + +- *Type:* EnterpriseActionsPermissionsEnabledOrganizationsConfig + +--- + +##### `EnabledOrganizationsInput`Optional + +```csharp +public string EnabledOrganizationsInput { get; } +``` + +- *Type:* string + +--- + +##### `EnterpriseSlugInput`Optional + +```csharp +public string EnterpriseSlugInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `AllowedActions`Required + +```csharp +public string AllowedActions { get; } +``` + +- *Type:* string + +--- + +##### `EnabledOrganizations`Required + +```csharp +public string EnabledOrganizations { get; } +``` + +- *Type:* string + +--- + +##### `EnterpriseSlug`Required + +```csharp +public string EnterpriseSlug { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### EnterpriseActionsPermissionsAllowedActionsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new EnterpriseActionsPermissionsAllowedActionsConfig { + bool|IResolvable GithubOwnedAllowed, + string[] PatternsAllowed = null, + bool|IResolvable VerifiedAllowed = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GithubOwnedAllowed | bool\|Io.Cdktn.IResolvable | Whether GitHub-owned actions are allowed in the enterprise. | +| PatternsAllowed | string[] | Specifies a list of string-matching patterns to allow specific action(s). | +| VerifiedAllowed | bool\|Io.Cdktn.IResolvable | Whether actions in GitHub Marketplace from verified creators are allowed. | + +--- + +##### `GithubOwnedAllowed`Required + +```csharp +public bool|IResolvable GithubOwnedAllowed { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether GitHub-owned actions are allowed in the enterprise. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#github_owned_allowed EnterpriseActionsPermissions#github_owned_allowed} + +--- + +##### `PatternsAllowed`Optional + +```csharp +public string[] PatternsAllowed { get; set; } +``` + +- *Type:* string[] + +Specifies a list of string-matching patterns to allow specific action(s). + +Wildcards, tags, and SHAs are allowed. For example, 'monalisa/octocat@', 'monalisa/octocat@v2', 'monalisa/'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#patterns_allowed EnterpriseActionsPermissions#patterns_allowed} + +--- + +##### `VerifiedAllowed`Optional + +```csharp +public bool|IResolvable VerifiedAllowed { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether actions in GitHub Marketplace from verified creators are allowed. + +Set to 'true' to allow all GitHub Marketplace actions by verified creators. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#verified_allowed EnterpriseActionsPermissions#verified_allowed} + +--- + +### EnterpriseActionsPermissionsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new EnterpriseActionsPermissionsConfig { + 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 EnabledOrganizations, + string EnterpriseSlug, + string AllowedActions = null, + EnterpriseActionsPermissionsAllowedActionsConfig AllowedActionsConfig = null, + EnterpriseActionsPermissionsEnabledOrganizationsConfig EnabledOrganizationsConfig = null, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| EnabledOrganizations | string | The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. | +| EnterpriseSlug | string | The slug of the enterprise. | +| AllowedActions | string | The permissions policy that controls the actions that are allowed to run. | +| AllowedActionsConfig | EnterpriseActionsPermissionsAllowedActionsConfig | allowed_actions_config block. | +| EnabledOrganizationsConfig | EnterpriseActionsPermissionsEnabledOrganizationsConfig | enabled_organizations_config block. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#id EnterpriseActionsPermissions#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `EnabledOrganizations`Required + +```csharp +public string EnabledOrganizations { get; set; } +``` + +- *Type:* string + +The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. + +Can be one of: 'all', 'none', or 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#enabled_organizations EnterpriseActionsPermissions#enabled_organizations} + +--- + +##### `EnterpriseSlug`Required + +```csharp +public string EnterpriseSlug { get; set; } +``` + +- *Type:* string + +The slug of the enterprise. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#enterprise_slug EnterpriseActionsPermissions#enterprise_slug} + +--- + +##### `AllowedActions`Optional + +```csharp +public string AllowedActions { get; set; } +``` + +- *Type:* string + +The permissions policy that controls the actions that are allowed to run. + +Can be one of: 'all', 'local_only', or 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#allowed_actions EnterpriseActionsPermissions#allowed_actions} + +--- + +##### `AllowedActionsConfig`Optional + +```csharp +public EnterpriseActionsPermissionsAllowedActionsConfig AllowedActionsConfig { get; set; } +``` + +- *Type:* EnterpriseActionsPermissionsAllowedActionsConfig + +allowed_actions_config block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#allowed_actions_config EnterpriseActionsPermissions#allowed_actions_config} + +--- + +##### `EnabledOrganizationsConfig`Optional + +```csharp +public EnterpriseActionsPermissionsEnabledOrganizationsConfig EnabledOrganizationsConfig { get; set; } +``` + +- *Type:* EnterpriseActionsPermissionsEnabledOrganizationsConfig + +enabled_organizations_config block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#enabled_organizations_config EnterpriseActionsPermissions#enabled_organizations_config} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#id EnterpriseActionsPermissions#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. + +--- + +### EnterpriseActionsPermissionsEnabledOrganizationsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new EnterpriseActionsPermissionsEnabledOrganizationsConfig { + double[] OrganizationIds +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| OrganizationIds | double[] | List of organization IDs to enable for GitHub Actions. | + +--- + +##### `OrganizationIds`Required + +```csharp +public double[] OrganizationIds { get; set; } +``` + +- *Type:* double[] + +List of organization IDs to enable for GitHub Actions. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#organization_ids EnterpriseActionsPermissions#organization_ids} + +--- + +## Classes + +### EnterpriseActionsPermissionsAllowedActionsConfigOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new EnterpriseActionsPermissionsAllowedActionsConfigOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetPatternsAllowed | *No description.* | +| ResetVerifiedAllowed | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetPatternsAllowed` + +```csharp +private void ResetPatternsAllowed() +``` + +##### `ResetVerifiedAllowed` + +```csharp +private void ResetVerifiedAllowed() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| GithubOwnedAllowedInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| PatternsAllowedInput | string[] | *No description.* | +| VerifiedAllowedInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| GithubOwnedAllowed | bool\|Io.Cdktn.IResolvable | *No description.* | +| PatternsAllowed | string[] | *No description.* | +| VerifiedAllowed | bool\|Io.Cdktn.IResolvable | *No description.* | +| InternalValue | EnterpriseActionsPermissionsAllowedActionsConfig | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `GithubOwnedAllowedInput`Optional + +```csharp +public bool|IResolvable GithubOwnedAllowedInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `PatternsAllowedInput`Optional + +```csharp +public string[] PatternsAllowedInput { get; } +``` + +- *Type:* string[] + +--- + +##### `VerifiedAllowedInput`Optional + +```csharp +public bool|IResolvable VerifiedAllowedInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `GithubOwnedAllowed`Required + +```csharp +public bool|IResolvable GithubOwnedAllowed { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `PatternsAllowed`Required + +```csharp +public string[] PatternsAllowed { get; } +``` + +- *Type:* string[] + +--- + +##### `VerifiedAllowed`Required + +```csharp +public bool|IResolvable VerifiedAllowed { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `InternalValue`Optional + +```csharp +public EnterpriseActionsPermissionsAllowedActionsConfig InternalValue { get; } +``` + +- *Type:* EnterpriseActionsPermissionsAllowedActionsConfig + +--- + + +### EnterpriseActionsPermissionsEnabledOrganizationsConfigOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new EnterpriseActionsPermissionsEnabledOrganizationsConfigOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| OrganizationIdsInput | double[] | *No description.* | +| OrganizationIds | double[] | *No description.* | +| InternalValue | EnterpriseActionsPermissionsEnabledOrganizationsConfig | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `OrganizationIdsInput`Optional + +```csharp +public double[] OrganizationIdsInput { get; } +``` + +- *Type:* double[] + +--- + +##### `OrganizationIds`Required + +```csharp +public double[] OrganizationIds { get; } +``` + +- *Type:* double[] + +--- + +##### `InternalValue`Optional + +```csharp +public EnterpriseActionsPermissionsEnabledOrganizationsConfig InternalValue { get; } +``` + +- *Type:* EnterpriseActionsPermissionsEnabledOrganizationsConfig + +--- + + + diff --git a/docs/enterpriseActionsPermissions.java.md b/docs/enterpriseActionsPermissions.java.md new file mode 100644 index 000000000..56e3210d6 --- /dev/null +++ b/docs/enterpriseActionsPermissions.java.md @@ -0,0 +1,1911 @@ +# `enterpriseActionsPermissions` Submodule + +## Constructs + +### EnterpriseActionsPermissions + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions github_enterprise_actions_permissions}. + +#### Initializers + +```java +import io.cdktn.providers.github.enterprise_actions_permissions.EnterpriseActionsPermissions; + +EnterpriseActionsPermissions.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .enabledOrganizations(java.lang.String) + .enterpriseSlug(java.lang.String) +// .allowedActions(java.lang.String) +// .allowedActionsConfig(EnterpriseActionsPermissionsAllowedActionsConfig) +// .enabledOrganizationsConfig(EnterpriseActionsPermissionsEnabledOrganizationsConfig) +// .id(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 | *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 | *No description.* | +| enabledOrganizations | java.lang.String | The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. | +| enterpriseSlug | java.lang.String | The slug of the enterprise. | +| allowedActions | java.lang.String | The permissions policy that controls the actions that are allowed to run. | +| allowedActionsConfig | EnterpriseActionsPermissionsAllowedActionsConfig | allowed_actions_config block. | +| enabledOrganizationsConfig | EnterpriseActionsPermissionsEnabledOrganizationsConfig | enabled_organizations_config block. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#id EnterpriseActionsPermissions#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `enabledOrganizations`Required + +- *Type:* java.lang.String + +The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. + +Can be one of: 'all', 'none', or 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#enabled_organizations EnterpriseActionsPermissions#enabled_organizations} + +--- + +##### `enterpriseSlug`Required + +- *Type:* java.lang.String + +The slug of the enterprise. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#enterprise_slug EnterpriseActionsPermissions#enterprise_slug} + +--- + +##### `allowedActions`Optional + +- *Type:* java.lang.String + +The permissions policy that controls the actions that are allowed to run. + +Can be one of: 'all', 'local_only', or 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#allowed_actions EnterpriseActionsPermissions#allowed_actions} + +--- + +##### `allowedActionsConfig`Optional + +- *Type:* EnterpriseActionsPermissionsAllowedActionsConfig + +allowed_actions_config block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#allowed_actions_config EnterpriseActionsPermissions#allowed_actions_config} + +--- + +##### `enabledOrganizationsConfig`Optional + +- *Type:* EnterpriseActionsPermissionsEnabledOrganizationsConfig + +enabled_organizations_config block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#enabled_organizations_config EnterpriseActionsPermissions#enabled_organizations_config} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#id EnterpriseActionsPermissions#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| putAllowedActionsConfig | *No description.* | +| putEnabledOrganizationsConfig | *No description.* | +| resetAllowedActions | *No description.* | +| resetAllowedActionsConfig | *No description.* | +| resetEnabledOrganizationsConfig | *No description.* | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `putAllowedActionsConfig` + +```java +public void putAllowedActionsConfig(EnterpriseActionsPermissionsAllowedActionsConfig value) +``` + +###### `value`Required + +- *Type:* EnterpriseActionsPermissionsAllowedActionsConfig + +--- + +##### `putEnabledOrganizationsConfig` + +```java +public void putEnabledOrganizationsConfig(EnterpriseActionsPermissionsEnabledOrganizationsConfig value) +``` + +###### `value`Required + +- *Type:* EnterpriseActionsPermissionsEnabledOrganizationsConfig + +--- + +##### `resetAllowedActions` + +```java +public void resetAllowedActions() +``` + +##### `resetAllowedActionsConfig` + +```java +public void resetAllowedActionsConfig() +``` + +##### `resetEnabledOrganizationsConfig` + +```java +public void resetEnabledOrganizationsConfig() +``` + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a EnterpriseActionsPermissions resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.enterprise_actions_permissions.EnterpriseActionsPermissions; + +EnterpriseActionsPermissions.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` + +```java +import io.cdktn.providers.github.enterprise_actions_permissions.EnterpriseActionsPermissions; + +EnterpriseActionsPermissions.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.enterprise_actions_permissions.EnterpriseActionsPermissions; + +EnterpriseActionsPermissions.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.enterprise_actions_permissions.EnterpriseActionsPermissions; + +EnterpriseActionsPermissions.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),EnterpriseActionsPermissions.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a EnterpriseActionsPermissions 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 EnterpriseActionsPermissions to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing EnterpriseActionsPermissions that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#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 EnterpriseActionsPermissions 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| allowedActionsConfig | EnterpriseActionsPermissionsAllowedActionsConfigOutputReference | *No description.* | +| enabledOrganizationsConfig | EnterpriseActionsPermissionsEnabledOrganizationsConfigOutputReference | *No description.* | +| allowedActionsConfigInput | EnterpriseActionsPermissionsAllowedActionsConfig | *No description.* | +| allowedActionsInput | java.lang.String | *No description.* | +| enabledOrganizationsConfigInput | EnterpriseActionsPermissionsEnabledOrganizationsConfig | *No description.* | +| enabledOrganizationsInput | java.lang.String | *No description.* | +| enterpriseSlugInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| allowedActions | java.lang.String | *No description.* | +| enabledOrganizations | java.lang.String | *No description.* | +| enterpriseSlug | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `allowedActionsConfig`Required + +```java +public EnterpriseActionsPermissionsAllowedActionsConfigOutputReference getAllowedActionsConfig(); +``` + +- *Type:* EnterpriseActionsPermissionsAllowedActionsConfigOutputReference + +--- + +##### `enabledOrganizationsConfig`Required + +```java +public EnterpriseActionsPermissionsEnabledOrganizationsConfigOutputReference getEnabledOrganizationsConfig(); +``` + +- *Type:* EnterpriseActionsPermissionsEnabledOrganizationsConfigOutputReference + +--- + +##### `allowedActionsConfigInput`Optional + +```java +public EnterpriseActionsPermissionsAllowedActionsConfig getAllowedActionsConfigInput(); +``` + +- *Type:* EnterpriseActionsPermissionsAllowedActionsConfig + +--- + +##### `allowedActionsInput`Optional + +```java +public java.lang.String getAllowedActionsInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `enabledOrganizationsConfigInput`Optional + +```java +public EnterpriseActionsPermissionsEnabledOrganizationsConfig getEnabledOrganizationsConfigInput(); +``` + +- *Type:* EnterpriseActionsPermissionsEnabledOrganizationsConfig + +--- + +##### `enabledOrganizationsInput`Optional + +```java +public java.lang.String getEnabledOrganizationsInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `enterpriseSlugInput`Optional + +```java +public java.lang.String getEnterpriseSlugInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `allowedActions`Required + +```java +public java.lang.String getAllowedActions(); +``` + +- *Type:* java.lang.String + +--- + +##### `enabledOrganizations`Required + +```java +public java.lang.String getEnabledOrganizations(); +``` + +- *Type:* java.lang.String + +--- + +##### `enterpriseSlug`Required + +```java +public java.lang.String getEnterpriseSlug(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### EnterpriseActionsPermissionsAllowedActionsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.enterprise_actions_permissions.EnterpriseActionsPermissionsAllowedActionsConfig; + +EnterpriseActionsPermissionsAllowedActionsConfig.builder() + .githubOwnedAllowed(java.lang.Boolean|IResolvable) +// .patternsAllowed(java.util.List) +// .verifiedAllowed(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| githubOwnedAllowed | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether GitHub-owned actions are allowed in the enterprise. | +| patternsAllowed | java.util.List | Specifies a list of string-matching patterns to allow specific action(s). | +| verifiedAllowed | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether actions in GitHub Marketplace from verified creators are allowed. | + +--- + +##### `githubOwnedAllowed`Required + +```java +public java.lang.Boolean|IResolvable getGithubOwnedAllowed(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether GitHub-owned actions are allowed in the enterprise. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#github_owned_allowed EnterpriseActionsPermissions#github_owned_allowed} + +--- + +##### `patternsAllowed`Optional + +```java +public java.util.List getPatternsAllowed(); +``` + +- *Type:* java.util.List + +Specifies a list of string-matching patterns to allow specific action(s). + +Wildcards, tags, and SHAs are allowed. For example, 'monalisa/octocat@', 'monalisa/octocat@v2', 'monalisa/'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#patterns_allowed EnterpriseActionsPermissions#patterns_allowed} + +--- + +##### `verifiedAllowed`Optional + +```java +public java.lang.Boolean|IResolvable getVerifiedAllowed(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether actions in GitHub Marketplace from verified creators are allowed. + +Set to 'true' to allow all GitHub Marketplace actions by verified creators. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#verified_allowed EnterpriseActionsPermissions#verified_allowed} + +--- + +### EnterpriseActionsPermissionsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.enterprise_actions_permissions.EnterpriseActionsPermissionsConfig; + +EnterpriseActionsPermissionsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .enabledOrganizations(java.lang.String) + .enterpriseSlug(java.lang.String) +// .allowedActions(java.lang.String) +// .allowedActionsConfig(EnterpriseActionsPermissionsAllowedActionsConfig) +// .enabledOrganizationsConfig(EnterpriseActionsPermissionsEnabledOrganizationsConfig) +// .id(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 | *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 | *No description.* | +| enabledOrganizations | java.lang.String | The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. | +| enterpriseSlug | java.lang.String | The slug of the enterprise. | +| allowedActions | java.lang.String | The permissions policy that controls the actions that are allowed to run. | +| allowedActionsConfig | EnterpriseActionsPermissionsAllowedActionsConfig | allowed_actions_config block. | +| enabledOrganizationsConfig | EnterpriseActionsPermissionsEnabledOrganizationsConfig | enabled_organizations_config block. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#id EnterpriseActionsPermissions#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `enabledOrganizations`Required + +```java +public java.lang.String getEnabledOrganizations(); +``` + +- *Type:* java.lang.String + +The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. + +Can be one of: 'all', 'none', or 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#enabled_organizations EnterpriseActionsPermissions#enabled_organizations} + +--- + +##### `enterpriseSlug`Required + +```java +public java.lang.String getEnterpriseSlug(); +``` + +- *Type:* java.lang.String + +The slug of the enterprise. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#enterprise_slug EnterpriseActionsPermissions#enterprise_slug} + +--- + +##### `allowedActions`Optional + +```java +public java.lang.String getAllowedActions(); +``` + +- *Type:* java.lang.String + +The permissions policy that controls the actions that are allowed to run. + +Can be one of: 'all', 'local_only', or 'selected'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#allowed_actions EnterpriseActionsPermissions#allowed_actions} + +--- + +##### `allowedActionsConfig`Optional + +```java +public EnterpriseActionsPermissionsAllowedActionsConfig getAllowedActionsConfig(); +``` + +- *Type:* EnterpriseActionsPermissionsAllowedActionsConfig + +allowed_actions_config block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#allowed_actions_config EnterpriseActionsPermissions#allowed_actions_config} + +--- + +##### `enabledOrganizationsConfig`Optional + +```java +public EnterpriseActionsPermissionsEnabledOrganizationsConfig getEnabledOrganizationsConfig(); +``` + +- *Type:* EnterpriseActionsPermissionsEnabledOrganizationsConfig + +enabled_organizations_config block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#enabled_organizations_config EnterpriseActionsPermissions#enabled_organizations_config} + +--- + +##### `id`Optional + +```java +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/resources/enterprise_actions_permissions#id EnterpriseActionsPermissions#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. + +--- + +### EnterpriseActionsPermissionsEnabledOrganizationsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.enterprise_actions_permissions.EnterpriseActionsPermissionsEnabledOrganizationsConfig; + +EnterpriseActionsPermissionsEnabledOrganizationsConfig.builder() + .organizationIds(java.util.List) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| organizationIds | java.util.List | List of organization IDs to enable for GitHub Actions. | + +--- + +##### `organizationIds`Required + +```java +public java.util.List getOrganizationIds(); +``` + +- *Type:* java.util.List + +List of organization IDs to enable for GitHub Actions. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_permissions#organization_ids EnterpriseActionsPermissions#organization_ids} + +--- + +## Classes + +### EnterpriseActionsPermissionsAllowedActionsConfigOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.enterprise_actions_permissions.EnterpriseActionsPermissionsAllowedActionsConfigOutputReference; + +new EnterpriseActionsPermissionsAllowedActionsConfigOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetPatternsAllowed | *No description.* | +| resetVerifiedAllowed | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetPatternsAllowed` + +```java +public void resetPatternsAllowed() +``` + +##### `resetVerifiedAllowed` + +```java +public void resetVerifiedAllowed() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| githubOwnedAllowedInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| patternsAllowedInput | java.util.List | *No description.* | +| verifiedAllowedInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| githubOwnedAllowed | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| patternsAllowed | java.util.List | *No description.* | +| verifiedAllowed | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| internalValue | EnterpriseActionsPermissionsAllowedActionsConfig | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `githubOwnedAllowedInput`Optional + +```java +public java.lang.Boolean|IResolvable getGithubOwnedAllowedInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `patternsAllowedInput`Optional + +```java +public java.util.List getPatternsAllowedInput(); +``` + +- *Type:* java.util.List + +--- + +##### `verifiedAllowedInput`Optional + +```java +public java.lang.Boolean|IResolvable getVerifiedAllowedInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `githubOwnedAllowed`Required + +```java +public java.lang.Boolean|IResolvable getGithubOwnedAllowed(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `patternsAllowed`Required + +```java +public java.util.List getPatternsAllowed(); +``` + +- *Type:* java.util.List + +--- + +##### `verifiedAllowed`Required + +```java +public java.lang.Boolean|IResolvable getVerifiedAllowed(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `internalValue`Optional + +```java +public EnterpriseActionsPermissionsAllowedActionsConfig getInternalValue(); +``` + +- *Type:* EnterpriseActionsPermissionsAllowedActionsConfig + +--- + + +### EnterpriseActionsPermissionsEnabledOrganizationsConfigOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.enterprise_actions_permissions.EnterpriseActionsPermissionsEnabledOrganizationsConfigOutputReference; + +new EnterpriseActionsPermissionsEnabledOrganizationsConfigOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| organizationIdsInput | java.util.List | *No description.* | +| organizationIds | java.util.List | *No description.* | +| internalValue | EnterpriseActionsPermissionsEnabledOrganizationsConfig | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `organizationIdsInput`Optional + +```java +public java.util.List getOrganizationIdsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `organizationIds`Required + +```java +public java.util.List getOrganizationIds(); +``` + +- *Type:* java.util.List + +--- + +##### `internalValue`Optional + +```java +public EnterpriseActionsPermissionsEnabledOrganizationsConfig getInternalValue(); +``` + +- *Type:* EnterpriseActionsPermissionsEnabledOrganizationsConfig + +--- + + + diff --git a/docs/enterpriseActionsRunnerGroup.csharp.md b/docs/enterpriseActionsRunnerGroup.csharp.md new file mode 100644 index 000000000..ae896aeb8 --- /dev/null +++ b/docs/enterpriseActionsRunnerGroup.csharp.md @@ -0,0 +1,1178 @@ +# `enterpriseActionsRunnerGroup` Submodule + +## Constructs + +### EnterpriseActionsRunnerGroup + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group github_enterprise_actions_runner_group}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new EnterpriseActionsRunnerGroup(Construct Scope, string Id, EnterpriseActionsRunnerGroupConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | EnterpriseActionsRunnerGroupConfig | *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:* EnterpriseActionsRunnerGroupConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetAllowsPublicRepositories | *No description.* | +| ResetId | *No description.* | +| ResetRestrictedToWorkflows | *No description.* | +| ResetSelectedOrganizationIds | *No description.* | +| ResetSelectedWorkflows | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetAllowsPublicRepositories` + +```csharp +private void ResetAllowsPublicRepositories() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetRestrictedToWorkflows` + +```csharp +private void ResetRestrictedToWorkflows() +``` + +##### `ResetSelectedOrganizationIds` + +```csharp +private void ResetSelectedOrganizationIds() +``` + +##### `ResetSelectedWorkflows` + +```csharp +private void ResetSelectedWorkflows() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a EnterpriseActionsRunnerGroup resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseActionsRunnerGroup.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` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseActionsRunnerGroup.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseActionsRunnerGroup.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseActionsRunnerGroup.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a EnterpriseActionsRunnerGroup resource upon running "cdktn 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 EnterpriseActionsRunnerGroup to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing EnterpriseActionsRunnerGroup that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the EnterpriseActionsRunnerGroup to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Default | Io.Cdktn.IResolvable | *No description.* | +| Etag | string | *No description.* | +| RunnersUrl | string | *No description.* | +| SelectedOrganizationsUrl | string | *No description.* | +| AllowsPublicRepositoriesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| EnterpriseSlugInput | string | *No description.* | +| IdInput | string | *No description.* | +| NameInput | string | *No description.* | +| RestrictedToWorkflowsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| SelectedOrganizationIdsInput | double[] | *No description.* | +| SelectedWorkflowsInput | string[] | *No description.* | +| VisibilityInput | string | *No description.* | +| AllowsPublicRepositories | bool\|Io.Cdktn.IResolvable | *No description.* | +| EnterpriseSlug | string | *No description.* | +| Id | string | *No description.* | +| Name | string | *No description.* | +| RestrictedToWorkflows | bool\|Io.Cdktn.IResolvable | *No description.* | +| SelectedOrganizationIds | double[] | *No description.* | +| SelectedWorkflows | string[] | *No description.* | +| Visibility | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Default`Required + +```csharp +public IResolvable Default { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `RunnersUrl`Required + +```csharp +public string RunnersUrl { get; } +``` + +- *Type:* string + +--- + +##### `SelectedOrganizationsUrl`Required + +```csharp +public string SelectedOrganizationsUrl { get; } +``` + +- *Type:* string + +--- + +##### `AllowsPublicRepositoriesInput`Optional + +```csharp +public bool|IResolvable AllowsPublicRepositoriesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `EnterpriseSlugInput`Optional + +```csharp +public string EnterpriseSlugInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `RestrictedToWorkflowsInput`Optional + +```csharp +public bool|IResolvable RestrictedToWorkflowsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `SelectedOrganizationIdsInput`Optional + +```csharp +public double[] SelectedOrganizationIdsInput { get; } +``` + +- *Type:* double[] + +--- + +##### `SelectedWorkflowsInput`Optional + +```csharp +public string[] SelectedWorkflowsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `VisibilityInput`Optional + +```csharp +public string VisibilityInput { get; } +``` + +- *Type:* string + +--- + +##### `AllowsPublicRepositories`Required + +```csharp +public bool|IResolvable AllowsPublicRepositories { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `EnterpriseSlug`Required + +```csharp +public string EnterpriseSlug { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `RestrictedToWorkflows`Required + +```csharp +public bool|IResolvable RestrictedToWorkflows { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `SelectedOrganizationIds`Required + +```csharp +public double[] SelectedOrganizationIds { get; } +``` + +- *Type:* double[] + +--- + +##### `SelectedWorkflows`Required + +```csharp +public string[] SelectedWorkflows { get; } +``` + +- *Type:* string[] + +--- + +##### `Visibility`Required + +```csharp +public string Visibility { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### EnterpriseActionsRunnerGroupConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new EnterpriseActionsRunnerGroupConfig { + 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 EnterpriseSlug, + string Name, + string Visibility, + bool|IResolvable AllowsPublicRepositories = null, + string Id = null, + bool|IResolvable RestrictedToWorkflows = null, + double[] SelectedOrganizationIds = null, + string[] SelectedWorkflows = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| EnterpriseSlug | string | The slug of the enterprise. | +| Name | string | Name of the runner group. | +| Visibility | string | The visibility of the runner group. | +| AllowsPublicRepositories | bool\|Io.Cdktn.IResolvable | Whether public repositories can be added to the runner group. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#id EnterpriseActionsRunnerGroup#id}. | +| RestrictedToWorkflows | bool\|Io.Cdktn.IResolvable | If 'true', the runner group will be restricted to running only the workflows specified in the 'selected_workflows' array. | +| SelectedOrganizationIds | double[] | List of organization IDs that can access the runner group. | +| SelectedWorkflows | string[] | List of workflows the runner group should be allowed to run. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `EnterpriseSlug`Required + +```csharp +public string EnterpriseSlug { get; set; } +``` + +- *Type:* string + +The slug of the enterprise. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#enterprise_slug EnterpriseActionsRunnerGroup#enterprise_slug} + +--- + +##### `Name`Required + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +Name of the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#name EnterpriseActionsRunnerGroup#name} + +--- + +##### `Visibility`Required + +```csharp +public string Visibility { get; set; } +``` + +- *Type:* string + +The visibility of the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#visibility EnterpriseActionsRunnerGroup#visibility} + +--- + +##### `AllowsPublicRepositories`Optional + +```csharp +public bool|IResolvable AllowsPublicRepositories { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether public repositories can be added to the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#allows_public_repositories EnterpriseActionsRunnerGroup#allows_public_repositories} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#id EnterpriseActionsRunnerGroup#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. + +--- + +##### `RestrictedToWorkflows`Optional + +```csharp +public bool|IResolvable RestrictedToWorkflows { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +If 'true', the runner group will be restricted to running only the workflows specified in the 'selected_workflows' array. + +Defaults to 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#restricted_to_workflows EnterpriseActionsRunnerGroup#restricted_to_workflows} + +--- + +##### `SelectedOrganizationIds`Optional + +```csharp +public double[] SelectedOrganizationIds { get; set; } +``` + +- *Type:* double[] + +List of organization IDs that can access the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#selected_organization_ids EnterpriseActionsRunnerGroup#selected_organization_ids} + +--- + +##### `SelectedWorkflows`Optional + +```csharp +public string[] SelectedWorkflows { get; set; } +``` + +- *Type:* string[] + +List of workflows the runner group should be allowed to run. + +This setting will be ignored unless restricted_to_workflows is set to 'true'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#selected_workflows EnterpriseActionsRunnerGroup#selected_workflows} + +--- + + + diff --git a/docs/enterpriseActionsRunnerGroup.java.md b/docs/enterpriseActionsRunnerGroup.java.md new file mode 100644 index 000000000..19d79954c --- /dev/null +++ b/docs/enterpriseActionsRunnerGroup.java.md @@ -0,0 +1,1331 @@ +# `enterpriseActionsRunnerGroup` Submodule + +## Constructs + +### EnterpriseActionsRunnerGroup + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group github_enterprise_actions_runner_group}. + +#### Initializers + +```java +import io.cdktn.providers.github.enterprise_actions_runner_group.EnterpriseActionsRunnerGroup; + +EnterpriseActionsRunnerGroup.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .enterpriseSlug(java.lang.String) + .name(java.lang.String) + .visibility(java.lang.String) +// .allowsPublicRepositories(java.lang.Boolean|IResolvable) +// .id(java.lang.String) +// .restrictedToWorkflows(java.lang.Boolean|IResolvable) +// .selectedOrganizationIds(java.util.List) +// .selectedWorkflows(java.util.List) + .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 | *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 | *No description.* | +| enterpriseSlug | java.lang.String | The slug of the enterprise. | +| name | java.lang.String | Name of the runner group. | +| visibility | java.lang.String | The visibility of the runner group. | +| allowsPublicRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether public repositories can be added to the runner group. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#id EnterpriseActionsRunnerGroup#id}. | +| restrictedToWorkflows | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | If 'true', the runner group will be restricted to running only the workflows specified in the 'selected_workflows' array. | +| selectedOrganizationIds | java.util.List | List of organization IDs that can access the runner group. | +| selectedWorkflows | java.util.List | List of workflows the runner group should be allowed to run. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `enterpriseSlug`Required + +- *Type:* java.lang.String + +The slug of the enterprise. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#enterprise_slug EnterpriseActionsRunnerGroup#enterprise_slug} + +--- + +##### `name`Required + +- *Type:* java.lang.String + +Name of the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#name EnterpriseActionsRunnerGroup#name} + +--- + +##### `visibility`Required + +- *Type:* java.lang.String + +The visibility of the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#visibility EnterpriseActionsRunnerGroup#visibility} + +--- + +##### `allowsPublicRepositories`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether public repositories can be added to the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#allows_public_repositories EnterpriseActionsRunnerGroup#allows_public_repositories} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#id EnterpriseActionsRunnerGroup#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. + +--- + +##### `restrictedToWorkflows`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +If 'true', the runner group will be restricted to running only the workflows specified in the 'selected_workflows' array. + +Defaults to 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#restricted_to_workflows EnterpriseActionsRunnerGroup#restricted_to_workflows} + +--- + +##### `selectedOrganizationIds`Optional + +- *Type:* java.util.List + +List of organization IDs that can access the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#selected_organization_ids EnterpriseActionsRunnerGroup#selected_organization_ids} + +--- + +##### `selectedWorkflows`Optional + +- *Type:* java.util.List + +List of workflows the runner group should be allowed to run. + +This setting will be ignored unless restricted_to_workflows is set to 'true'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#selected_workflows EnterpriseActionsRunnerGroup#selected_workflows} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetAllowsPublicRepositories | *No description.* | +| resetId | *No description.* | +| resetRestrictedToWorkflows | *No description.* | +| resetSelectedOrganizationIds | *No description.* | +| resetSelectedWorkflows | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetAllowsPublicRepositories` + +```java +public void resetAllowsPublicRepositories() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetRestrictedToWorkflows` + +```java +public void resetRestrictedToWorkflows() +``` + +##### `resetSelectedOrganizationIds` + +```java +public void resetSelectedOrganizationIds() +``` + +##### `resetSelectedWorkflows` + +```java +public void resetSelectedWorkflows() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a EnterpriseActionsRunnerGroup resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.enterprise_actions_runner_group.EnterpriseActionsRunnerGroup; + +EnterpriseActionsRunnerGroup.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` + +```java +import io.cdktn.providers.github.enterprise_actions_runner_group.EnterpriseActionsRunnerGroup; + +EnterpriseActionsRunnerGroup.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.enterprise_actions_runner_group.EnterpriseActionsRunnerGroup; + +EnterpriseActionsRunnerGroup.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.enterprise_actions_runner_group.EnterpriseActionsRunnerGroup; + +EnterpriseActionsRunnerGroup.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),EnterpriseActionsRunnerGroup.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a EnterpriseActionsRunnerGroup 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 EnterpriseActionsRunnerGroup to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing EnterpriseActionsRunnerGroup that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#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 EnterpriseActionsRunnerGroup 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| default | io.cdktn.cdktn.IResolvable | *No description.* | +| etag | java.lang.String | *No description.* | +| runnersUrl | java.lang.String | *No description.* | +| selectedOrganizationsUrl | java.lang.String | *No description.* | +| allowsPublicRepositoriesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| enterpriseSlugInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| restrictedToWorkflowsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| selectedOrganizationIdsInput | java.util.List | *No description.* | +| selectedWorkflowsInput | java.util.List | *No description.* | +| visibilityInput | java.lang.String | *No description.* | +| allowsPublicRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| enterpriseSlug | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| restrictedToWorkflows | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| selectedOrganizationIds | java.util.List | *No description.* | +| selectedWorkflows | java.util.List | *No description.* | +| visibility | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `default`Required + +```java +public IResolvable getDefault(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `runnersUrl`Required + +```java +public java.lang.String getRunnersUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `selectedOrganizationsUrl`Required + +```java +public java.lang.String getSelectedOrganizationsUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `allowsPublicRepositoriesInput`Optional + +```java +public java.lang.Boolean|IResolvable getAllowsPublicRepositoriesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `enterpriseSlugInput`Optional + +```java +public java.lang.String getEnterpriseSlugInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `restrictedToWorkflowsInput`Optional + +```java +public java.lang.Boolean|IResolvable getRestrictedToWorkflowsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `selectedOrganizationIdsInput`Optional + +```java +public java.util.List getSelectedOrganizationIdsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `selectedWorkflowsInput`Optional + +```java +public java.util.List getSelectedWorkflowsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `visibilityInput`Optional + +```java +public java.lang.String getVisibilityInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `allowsPublicRepositories`Required + +```java +public java.lang.Boolean|IResolvable getAllowsPublicRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `enterpriseSlug`Required + +```java +public java.lang.String getEnterpriseSlug(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `restrictedToWorkflows`Required + +```java +public java.lang.Boolean|IResolvable getRestrictedToWorkflows(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `selectedOrganizationIds`Required + +```java +public java.util.List getSelectedOrganizationIds(); +``` + +- *Type:* java.util.List + +--- + +##### `selectedWorkflows`Required + +```java +public java.util.List getSelectedWorkflows(); +``` + +- *Type:* java.util.List + +--- + +##### `visibility`Required + +```java +public java.lang.String getVisibility(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### EnterpriseActionsRunnerGroupConfig + +#### Initializer + +```java +import io.cdktn.providers.github.enterprise_actions_runner_group.EnterpriseActionsRunnerGroupConfig; + +EnterpriseActionsRunnerGroupConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .enterpriseSlug(java.lang.String) + .name(java.lang.String) + .visibility(java.lang.String) +// .allowsPublicRepositories(java.lang.Boolean|IResolvable) +// .id(java.lang.String) +// .restrictedToWorkflows(java.lang.Boolean|IResolvable) +// .selectedOrganizationIds(java.util.List) +// .selectedWorkflows(java.util.List) + .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 | *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 | *No description.* | +| enterpriseSlug | java.lang.String | The slug of the enterprise. | +| name | java.lang.String | Name of the runner group. | +| visibility | java.lang.String | The visibility of the runner group. | +| allowsPublicRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether public repositories can be added to the runner group. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#id EnterpriseActionsRunnerGroup#id}. | +| restrictedToWorkflows | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | If 'true', the runner group will be restricted to running only the workflows specified in the 'selected_workflows' array. | +| selectedOrganizationIds | java.util.List | List of organization IDs that can access the runner group. | +| selectedWorkflows | java.util.List | List of workflows the runner group should be allowed to run. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `enterpriseSlug`Required + +```java +public java.lang.String getEnterpriseSlug(); +``` + +- *Type:* java.lang.String + +The slug of the enterprise. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#enterprise_slug EnterpriseActionsRunnerGroup#enterprise_slug} + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +Name of the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#name EnterpriseActionsRunnerGroup#name} + +--- + +##### `visibility`Required + +```java +public java.lang.String getVisibility(); +``` + +- *Type:* java.lang.String + +The visibility of the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#visibility EnterpriseActionsRunnerGroup#visibility} + +--- + +##### `allowsPublicRepositories`Optional + +```java +public java.lang.Boolean|IResolvable getAllowsPublicRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether public repositories can be added to the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#allows_public_repositories EnterpriseActionsRunnerGroup#allows_public_repositories} + +--- + +##### `id`Optional + +```java +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/resources/enterprise_actions_runner_group#id EnterpriseActionsRunnerGroup#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. + +--- + +##### `restrictedToWorkflows`Optional + +```java +public java.lang.Boolean|IResolvable getRestrictedToWorkflows(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +If 'true', the runner group will be restricted to running only the workflows specified in the 'selected_workflows' array. + +Defaults to 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#restricted_to_workflows EnterpriseActionsRunnerGroup#restricted_to_workflows} + +--- + +##### `selectedOrganizationIds`Optional + +```java +public java.util.List getSelectedOrganizationIds(); +``` + +- *Type:* java.util.List + +List of organization IDs that can access the runner group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#selected_organization_ids EnterpriseActionsRunnerGroup#selected_organization_ids} + +--- + +##### `selectedWorkflows`Optional + +```java +public java.util.List getSelectedWorkflows(); +``` + +- *Type:* java.util.List + +List of workflows the runner group should be allowed to run. + +This setting will be ignored unless restricted_to_workflows is set to 'true'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_runner_group#selected_workflows EnterpriseActionsRunnerGroup#selected_workflows} + +--- + + + diff --git a/docs/enterpriseActionsWorkflowPermissions.csharp.md b/docs/enterpriseActionsWorkflowPermissions.csharp.md new file mode 100644 index 000000000..7e9435060 --- /dev/null +++ b/docs/enterpriseActionsWorkflowPermissions.csharp.md @@ -0,0 +1,964 @@ +# `enterpriseActionsWorkflowPermissions` Submodule + +## Constructs + +### EnterpriseActionsWorkflowPermissions + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_workflow_permissions github_enterprise_actions_workflow_permissions}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new EnterpriseActionsWorkflowPermissions(Construct Scope, string Id, EnterpriseActionsWorkflowPermissionsConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | EnterpriseActionsWorkflowPermissionsConfig | *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:* EnterpriseActionsWorkflowPermissionsConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetCanApprovePullRequestReviews | *No description.* | +| ResetDefaultWorkflowPermissions | *No description.* | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetCanApprovePullRequestReviews` + +```csharp +private void ResetCanApprovePullRequestReviews() +``` + +##### `ResetDefaultWorkflowPermissions` + +```csharp +private void ResetDefaultWorkflowPermissions() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a EnterpriseActionsWorkflowPermissions resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseActionsWorkflowPermissions.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` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseActionsWorkflowPermissions.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseActionsWorkflowPermissions.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseActionsWorkflowPermissions.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a EnterpriseActionsWorkflowPermissions resource upon running "cdktn 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 EnterpriseActionsWorkflowPermissions to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing EnterpriseActionsWorkflowPermissions that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_workflow_permissions#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the EnterpriseActionsWorkflowPermissions to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| CanApprovePullRequestReviewsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| DefaultWorkflowPermissionsInput | string | *No description.* | +| EnterpriseSlugInput | string | *No description.* | +| IdInput | string | *No description.* | +| CanApprovePullRequestReviews | bool\|Io.Cdktn.IResolvable | *No description.* | +| DefaultWorkflowPermissions | string | *No description.* | +| EnterpriseSlug | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `CanApprovePullRequestReviewsInput`Optional + +```csharp +public bool|IResolvable CanApprovePullRequestReviewsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `DefaultWorkflowPermissionsInput`Optional + +```csharp +public string DefaultWorkflowPermissionsInput { get; } +``` + +- *Type:* string + +--- + +##### `EnterpriseSlugInput`Optional + +```csharp +public string EnterpriseSlugInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `CanApprovePullRequestReviews`Required + +```csharp +public bool|IResolvable CanApprovePullRequestReviews { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `DefaultWorkflowPermissions`Required + +```csharp +public string DefaultWorkflowPermissions { get; } +``` + +- *Type:* string + +--- + +##### `EnterpriseSlug`Required + +```csharp +public string EnterpriseSlug { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### EnterpriseActionsWorkflowPermissionsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new EnterpriseActionsWorkflowPermissionsConfig { + 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 EnterpriseSlug, + bool|IResolvable CanApprovePullRequestReviews = null, + string DefaultWorkflowPermissions = null, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| EnterpriseSlug | string | The slug of the enterprise. | +| CanApprovePullRequestReviews | bool\|Io.Cdktn.IResolvable | Whether GitHub Actions can approve pull request reviews. | +| DefaultWorkflowPermissions | string | The default workflow permissions granted to the GITHUB_TOKEN when running workflows. Can be 'read' or 'write'. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_workflow_permissions#id EnterpriseActionsWorkflowPermissions#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `EnterpriseSlug`Required + +```csharp +public string EnterpriseSlug { get; set; } +``` + +- *Type:* string + +The slug of the enterprise. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_workflow_permissions#enterprise_slug EnterpriseActionsWorkflowPermissions#enterprise_slug} + +--- + +##### `CanApprovePullRequestReviews`Optional + +```csharp +public bool|IResolvable CanApprovePullRequestReviews { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether GitHub Actions can approve pull request reviews. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_workflow_permissions#can_approve_pull_request_reviews EnterpriseActionsWorkflowPermissions#can_approve_pull_request_reviews} + +--- + +##### `DefaultWorkflowPermissions`Optional + +```csharp +public string DefaultWorkflowPermissions { get; set; } +``` + +- *Type:* string + +The default workflow permissions granted to the GITHUB_TOKEN when running workflows. Can be 'read' or 'write'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_workflow_permissions#default_workflow_permissions EnterpriseActionsWorkflowPermissions#default_workflow_permissions} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_workflow_permissions#id EnterpriseActionsWorkflowPermissions#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. + +--- + + + diff --git a/docs/enterpriseActionsWorkflowPermissions.java.md b/docs/enterpriseActionsWorkflowPermissions.java.md new file mode 100644 index 000000000..f855da73e --- /dev/null +++ b/docs/enterpriseActionsWorkflowPermissions.java.md @@ -0,0 +1,1065 @@ +# `enterpriseActionsWorkflowPermissions` Submodule + +## Constructs + +### EnterpriseActionsWorkflowPermissions + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_workflow_permissions github_enterprise_actions_workflow_permissions}. + +#### Initializers + +```java +import io.cdktn.providers.github.enterprise_actions_workflow_permissions.EnterpriseActionsWorkflowPermissions; + +EnterpriseActionsWorkflowPermissions.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .enterpriseSlug(java.lang.String) +// .canApprovePullRequestReviews(java.lang.Boolean|IResolvable) +// .defaultWorkflowPermissions(java.lang.String) +// .id(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 | *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 | *No description.* | +| enterpriseSlug | java.lang.String | The slug of the enterprise. | +| canApprovePullRequestReviews | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether GitHub Actions can approve pull request reviews. | +| defaultWorkflowPermissions | java.lang.String | The default workflow permissions granted to the GITHUB_TOKEN when running workflows. Can be 'read' or 'write'. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_workflow_permissions#id EnterpriseActionsWorkflowPermissions#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `enterpriseSlug`Required + +- *Type:* java.lang.String + +The slug of the enterprise. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_workflow_permissions#enterprise_slug EnterpriseActionsWorkflowPermissions#enterprise_slug} + +--- + +##### `canApprovePullRequestReviews`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether GitHub Actions can approve pull request reviews. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_workflow_permissions#can_approve_pull_request_reviews EnterpriseActionsWorkflowPermissions#can_approve_pull_request_reviews} + +--- + +##### `defaultWorkflowPermissions`Optional + +- *Type:* java.lang.String + +The default workflow permissions granted to the GITHUB_TOKEN when running workflows. Can be 'read' or 'write'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_workflow_permissions#default_workflow_permissions EnterpriseActionsWorkflowPermissions#default_workflow_permissions} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_workflow_permissions#id EnterpriseActionsWorkflowPermissions#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetCanApprovePullRequestReviews | *No description.* | +| resetDefaultWorkflowPermissions | *No description.* | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetCanApprovePullRequestReviews` + +```java +public void resetCanApprovePullRequestReviews() +``` + +##### `resetDefaultWorkflowPermissions` + +```java +public void resetDefaultWorkflowPermissions() +``` + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a EnterpriseActionsWorkflowPermissions resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.enterprise_actions_workflow_permissions.EnterpriseActionsWorkflowPermissions; + +EnterpriseActionsWorkflowPermissions.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` + +```java +import io.cdktn.providers.github.enterprise_actions_workflow_permissions.EnterpriseActionsWorkflowPermissions; + +EnterpriseActionsWorkflowPermissions.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.enterprise_actions_workflow_permissions.EnterpriseActionsWorkflowPermissions; + +EnterpriseActionsWorkflowPermissions.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.enterprise_actions_workflow_permissions.EnterpriseActionsWorkflowPermissions; + +EnterpriseActionsWorkflowPermissions.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),EnterpriseActionsWorkflowPermissions.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a EnterpriseActionsWorkflowPermissions 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 EnterpriseActionsWorkflowPermissions to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing EnterpriseActionsWorkflowPermissions that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_workflow_permissions#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 EnterpriseActionsWorkflowPermissions 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| canApprovePullRequestReviewsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| defaultWorkflowPermissionsInput | java.lang.String | *No description.* | +| enterpriseSlugInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| canApprovePullRequestReviews | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| defaultWorkflowPermissions | java.lang.String | *No description.* | +| enterpriseSlug | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `canApprovePullRequestReviewsInput`Optional + +```java +public java.lang.Boolean|IResolvable getCanApprovePullRequestReviewsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `defaultWorkflowPermissionsInput`Optional + +```java +public java.lang.String getDefaultWorkflowPermissionsInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `enterpriseSlugInput`Optional + +```java +public java.lang.String getEnterpriseSlugInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `canApprovePullRequestReviews`Required + +```java +public java.lang.Boolean|IResolvable getCanApprovePullRequestReviews(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `defaultWorkflowPermissions`Required + +```java +public java.lang.String getDefaultWorkflowPermissions(); +``` + +- *Type:* java.lang.String + +--- + +##### `enterpriseSlug`Required + +```java +public java.lang.String getEnterpriseSlug(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### EnterpriseActionsWorkflowPermissionsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.enterprise_actions_workflow_permissions.EnterpriseActionsWorkflowPermissionsConfig; + +EnterpriseActionsWorkflowPermissionsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .enterpriseSlug(java.lang.String) +// .canApprovePullRequestReviews(java.lang.Boolean|IResolvable) +// .defaultWorkflowPermissions(java.lang.String) +// .id(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 | *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 | *No description.* | +| enterpriseSlug | java.lang.String | The slug of the enterprise. | +| canApprovePullRequestReviews | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether GitHub Actions can approve pull request reviews. | +| defaultWorkflowPermissions | java.lang.String | The default workflow permissions granted to the GITHUB_TOKEN when running workflows. Can be 'read' or 'write'. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_workflow_permissions#id EnterpriseActionsWorkflowPermissions#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `enterpriseSlug`Required + +```java +public java.lang.String getEnterpriseSlug(); +``` + +- *Type:* java.lang.String + +The slug of the enterprise. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_workflow_permissions#enterprise_slug EnterpriseActionsWorkflowPermissions#enterprise_slug} + +--- + +##### `canApprovePullRequestReviews`Optional + +```java +public java.lang.Boolean|IResolvable getCanApprovePullRequestReviews(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether GitHub Actions can approve pull request reviews. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_workflow_permissions#can_approve_pull_request_reviews EnterpriseActionsWorkflowPermissions#can_approve_pull_request_reviews} + +--- + +##### `defaultWorkflowPermissions`Optional + +```java +public java.lang.String getDefaultWorkflowPermissions(); +``` + +- *Type:* java.lang.String + +The default workflow permissions granted to the GITHUB_TOKEN when running workflows. Can be 'read' or 'write'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_actions_workflow_permissions#default_workflow_permissions EnterpriseActionsWorkflowPermissions#default_workflow_permissions} + +--- + +##### `id`Optional + +```java +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/resources/enterprise_actions_workflow_permissions#id EnterpriseActionsWorkflowPermissions#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. + +--- + + + diff --git a/docs/enterpriseIpAllowListEntry.csharp.md b/docs/enterpriseIpAllowListEntry.csharp.md new file mode 100644 index 000000000..3c1618838 --- /dev/null +++ b/docs/enterpriseIpAllowListEntry.csharp.md @@ -0,0 +1,1024 @@ +# `enterpriseIpAllowListEntry` Submodule + +## Constructs + +### EnterpriseIpAllowListEntry + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_ip_allow_list_entry github_enterprise_ip_allow_list_entry}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new EnterpriseIpAllowListEntry(Construct Scope, string Id, EnterpriseIpAllowListEntryConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | EnterpriseIpAllowListEntryConfig | *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:* EnterpriseIpAllowListEntryConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | +| ResetIsActive | *No description.* | +| ResetName | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetIsActive` + +```csharp +private void ResetIsActive() +``` + +##### `ResetName` + +```csharp +private void ResetName() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a EnterpriseIpAllowListEntry resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseIpAllowListEntry.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` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseIpAllowListEntry.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseIpAllowListEntry.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseIpAllowListEntry.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a EnterpriseIpAllowListEntry resource upon running "cdktn 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 EnterpriseIpAllowListEntry to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing EnterpriseIpAllowListEntry that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_ip_allow_list_entry#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the EnterpriseIpAllowListEntry to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| CreatedAt | string | *No description.* | +| UpdatedAt | string | *No description.* | +| EnterpriseSlugInput | string | *No description.* | +| IdInput | string | *No description.* | +| IpInput | string | *No description.* | +| IsActiveInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| NameInput | string | *No description.* | +| EnterpriseSlug | string | *No description.* | +| Id | string | *No description.* | +| Ip | string | *No description.* | +| IsActive | bool\|Io.Cdktn.IResolvable | *No description.* | +| Name | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public string UpdatedAt { get; } +``` + +- *Type:* string + +--- + +##### `EnterpriseSlugInput`Optional + +```csharp +public string EnterpriseSlugInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `IpInput`Optional + +```csharp +public string IpInput { get; } +``` + +- *Type:* string + +--- + +##### `IsActiveInput`Optional + +```csharp +public bool|IResolvable IsActiveInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `EnterpriseSlug`Required + +```csharp +public string EnterpriseSlug { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Ip`Required + +```csharp +public string Ip { get; } +``` + +- *Type:* string + +--- + +##### `IsActive`Required + +```csharp +public bool|IResolvable IsActive { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### EnterpriseIpAllowListEntryConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new EnterpriseIpAllowListEntryConfig { + 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 EnterpriseSlug, + string Ip, + string Id = null, + bool|IResolvable IsActive = null, + string Name = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| EnterpriseSlug | string | The slug of the enterprise to apply the IP allow list entry to. | +| Ip | string | An IP address or range of IP addresses in CIDR notation. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_ip_allow_list_entry#id EnterpriseIpAllowListEntry#id}. | +| IsActive | bool\|Io.Cdktn.IResolvable | Whether the entry is currently active. | +| Name | string | An optional name for the IP allow list entry. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `EnterpriseSlug`Required + +```csharp +public string EnterpriseSlug { get; set; } +``` + +- *Type:* string + +The slug of the enterprise to apply the IP allow list entry to. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_ip_allow_list_entry#enterprise_slug EnterpriseIpAllowListEntry#enterprise_slug} + +--- + +##### `Ip`Required + +```csharp +public string Ip { get; set; } +``` + +- *Type:* string + +An IP address or range of IP addresses in CIDR notation. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_ip_allow_list_entry#ip EnterpriseIpAllowListEntry#ip} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_ip_allow_list_entry#id EnterpriseIpAllowListEntry#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. + +--- + +##### `IsActive`Optional + +```csharp +public bool|IResolvable IsActive { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether the entry is currently active. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_ip_allow_list_entry#is_active EnterpriseIpAllowListEntry#is_active} + +--- + +##### `Name`Optional + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +An optional name for the IP allow list entry. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_ip_allow_list_entry#name EnterpriseIpAllowListEntry#name} + +--- + + + diff --git a/docs/enterpriseIpAllowListEntry.java.md b/docs/enterpriseIpAllowListEntry.java.md new file mode 100644 index 000000000..39083aaf4 --- /dev/null +++ b/docs/enterpriseIpAllowListEntry.java.md @@ -0,0 +1,1137 @@ +# `enterpriseIpAllowListEntry` Submodule + +## Constructs + +### EnterpriseIpAllowListEntry + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_ip_allow_list_entry github_enterprise_ip_allow_list_entry}. + +#### Initializers + +```java +import io.cdktn.providers.github.enterprise_ip_allow_list_entry.EnterpriseIpAllowListEntry; + +EnterpriseIpAllowListEntry.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .enterpriseSlug(java.lang.String) + .ip(java.lang.String) +// .id(java.lang.String) +// .isActive(java.lang.Boolean|IResolvable) +// .name(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 | *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 | *No description.* | +| enterpriseSlug | java.lang.String | The slug of the enterprise to apply the IP allow list entry to. | +| ip | java.lang.String | An IP address or range of IP addresses in CIDR notation. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_ip_allow_list_entry#id EnterpriseIpAllowListEntry#id}. | +| isActive | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether the entry is currently active. | +| name | java.lang.String | An optional name for the IP allow list entry. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `enterpriseSlug`Required + +- *Type:* java.lang.String + +The slug of the enterprise to apply the IP allow list entry to. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_ip_allow_list_entry#enterprise_slug EnterpriseIpAllowListEntry#enterprise_slug} + +--- + +##### `ip`Required + +- *Type:* java.lang.String + +An IP address or range of IP addresses in CIDR notation. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_ip_allow_list_entry#ip EnterpriseIpAllowListEntry#ip} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_ip_allow_list_entry#id EnterpriseIpAllowListEntry#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. + +--- + +##### `isActive`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether the entry is currently active. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_ip_allow_list_entry#is_active EnterpriseIpAllowListEntry#is_active} + +--- + +##### `name`Optional + +- *Type:* java.lang.String + +An optional name for the IP allow list entry. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_ip_allow_list_entry#name EnterpriseIpAllowListEntry#name} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | +| resetIsActive | *No description.* | +| resetName | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetIsActive` + +```java +public void resetIsActive() +``` + +##### `resetName` + +```java +public void resetName() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a EnterpriseIpAllowListEntry resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.enterprise_ip_allow_list_entry.EnterpriseIpAllowListEntry; + +EnterpriseIpAllowListEntry.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` + +```java +import io.cdktn.providers.github.enterprise_ip_allow_list_entry.EnterpriseIpAllowListEntry; + +EnterpriseIpAllowListEntry.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.enterprise_ip_allow_list_entry.EnterpriseIpAllowListEntry; + +EnterpriseIpAllowListEntry.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.enterprise_ip_allow_list_entry.EnterpriseIpAllowListEntry; + +EnterpriseIpAllowListEntry.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),EnterpriseIpAllowListEntry.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a EnterpriseIpAllowListEntry 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 EnterpriseIpAllowListEntry to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing EnterpriseIpAllowListEntry that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_ip_allow_list_entry#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 EnterpriseIpAllowListEntry 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| createdAt | java.lang.String | *No description.* | +| updatedAt | java.lang.String | *No description.* | +| enterpriseSlugInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| ipInput | java.lang.String | *No description.* | +| isActiveInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| nameInput | java.lang.String | *No description.* | +| enterpriseSlug | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| ip | java.lang.String | *No description.* | +| isActive | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| name | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.String getUpdatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `enterpriseSlugInput`Optional + +```java +public java.lang.String getEnterpriseSlugInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `ipInput`Optional + +```java +public java.lang.String getIpInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `isActiveInput`Optional + +```java +public java.lang.Boolean|IResolvable getIsActiveInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `enterpriseSlug`Required + +```java +public java.lang.String getEnterpriseSlug(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `ip`Required + +```java +public java.lang.String getIp(); +``` + +- *Type:* java.lang.String + +--- + +##### `isActive`Required + +```java +public java.lang.Boolean|IResolvable getIsActive(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### EnterpriseIpAllowListEntryConfig + +#### Initializer + +```java +import io.cdktn.providers.github.enterprise_ip_allow_list_entry.EnterpriseIpAllowListEntryConfig; + +EnterpriseIpAllowListEntryConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .enterpriseSlug(java.lang.String) + .ip(java.lang.String) +// .id(java.lang.String) +// .isActive(java.lang.Boolean|IResolvable) +// .name(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 | *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 | *No description.* | +| enterpriseSlug | java.lang.String | The slug of the enterprise to apply the IP allow list entry to. | +| ip | java.lang.String | An IP address or range of IP addresses in CIDR notation. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_ip_allow_list_entry#id EnterpriseIpAllowListEntry#id}. | +| isActive | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether the entry is currently active. | +| name | java.lang.String | An optional name for the IP allow list entry. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `enterpriseSlug`Required + +```java +public java.lang.String getEnterpriseSlug(); +``` + +- *Type:* java.lang.String + +The slug of the enterprise to apply the IP allow list entry to. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_ip_allow_list_entry#enterprise_slug EnterpriseIpAllowListEntry#enterprise_slug} + +--- + +##### `ip`Required + +```java +public java.lang.String getIp(); +``` + +- *Type:* java.lang.String + +An IP address or range of IP addresses in CIDR notation. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_ip_allow_list_entry#ip EnterpriseIpAllowListEntry#ip} + +--- + +##### `id`Optional + +```java +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/resources/enterprise_ip_allow_list_entry#id EnterpriseIpAllowListEntry#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. + +--- + +##### `isActive`Optional + +```java +public java.lang.Boolean|IResolvable getIsActive(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether the entry is currently active. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_ip_allow_list_entry#is_active EnterpriseIpAllowListEntry#is_active} + +--- + +##### `name`Optional + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +An optional name for the IP allow list entry. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_ip_allow_list_entry#name EnterpriseIpAllowListEntry#name} + +--- + + + diff --git a/docs/enterpriseOrganization.csharp.md b/docs/enterpriseOrganization.csharp.md new file mode 100644 index 000000000..7c3651262 --- /dev/null +++ b/docs/enterpriseOrganization.csharp.md @@ -0,0 +1,1054 @@ +# `enterpriseOrganization` Submodule + +## Constructs + +### EnterpriseOrganization + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_organization github_enterprise_organization}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new EnterpriseOrganization(Construct Scope, string Id, EnterpriseOrganizationConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | EnterpriseOrganizationConfig | *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:* EnterpriseOrganizationConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetDescription | *No description.* | +| ResetDisplayName | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetDescription` + +```csharp +private void ResetDescription() +``` + +##### `ResetDisplayName` + +```csharp +private void ResetDisplayName() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a EnterpriseOrganization resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseOrganization.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` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseOrganization.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseOrganization.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseOrganization.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a EnterpriseOrganization resource upon running "cdktn 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 EnterpriseOrganization to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing EnterpriseOrganization that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_organization#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the EnterpriseOrganization to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| DatabaseId | double | *No description.* | +| Id | string | *No description.* | +| AdminLoginsInput | string[] | *No description.* | +| BillingEmailInput | string | *No description.* | +| DescriptionInput | string | *No description.* | +| DisplayNameInput | string | *No description.* | +| EnterpriseIdInput | string | *No description.* | +| NameInput | string | *No description.* | +| AdminLogins | string[] | *No description.* | +| BillingEmail | string | *No description.* | +| Description | string | *No description.* | +| DisplayName | string | *No description.* | +| EnterpriseId | string | *No description.* | +| Name | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `DatabaseId`Required + +```csharp +public double DatabaseId { get; } +``` + +- *Type:* double + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `AdminLoginsInput`Optional + +```csharp +public string[] AdminLoginsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `BillingEmailInput`Optional + +```csharp +public string BillingEmailInput { get; } +``` + +- *Type:* string + +--- + +##### `DescriptionInput`Optional + +```csharp +public string DescriptionInput { get; } +``` + +- *Type:* string + +--- + +##### `DisplayNameInput`Optional + +```csharp +public string DisplayNameInput { get; } +``` + +- *Type:* string + +--- + +##### `EnterpriseIdInput`Optional + +```csharp +public string EnterpriseIdInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `AdminLogins`Required + +```csharp +public string[] AdminLogins { get; } +``` + +- *Type:* string[] + +--- + +##### `BillingEmail`Required + +```csharp +public string BillingEmail { get; } +``` + +- *Type:* string + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `DisplayName`Required + +```csharp +public string DisplayName { get; } +``` + +- *Type:* string + +--- + +##### `EnterpriseId`Required + +```csharp +public string EnterpriseId { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### EnterpriseOrganizationConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new EnterpriseOrganizationConfig { + 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[] AdminLogins, + string BillingEmail, + string EnterpriseId, + string Name, + string Description = null, + string DisplayName = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| AdminLogins | string[] | List of organization owner usernames. | +| BillingEmail | string | The billing email address. | +| EnterpriseId | string | The ID of the enterprise. | +| Name | string | The name of the organization. | +| Description | string | The description of the organization. | +| DisplayName | string | The display name of the organization. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `AdminLogins`Required + +```csharp +public string[] AdminLogins { get; set; } +``` + +- *Type:* string[] + +List of organization owner usernames. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_organization#admin_logins EnterpriseOrganization#admin_logins} + +--- + +##### `BillingEmail`Required + +```csharp +public string BillingEmail { get; set; } +``` + +- *Type:* string + +The billing email address. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_organization#billing_email EnterpriseOrganization#billing_email} + +--- + +##### `EnterpriseId`Required + +```csharp +public string EnterpriseId { get; set; } +``` + +- *Type:* string + +The ID of the enterprise. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_organization#enterprise_id EnterpriseOrganization#enterprise_id} + +--- + +##### `Name`Required + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +The name of the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_organization#name EnterpriseOrganization#name} + +--- + +##### `Description`Optional + +```csharp +public string Description { get; set; } +``` + +- *Type:* string + +The description of the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_organization#description EnterpriseOrganization#description} + +--- + +##### `DisplayName`Optional + +```csharp +public string DisplayName { get; set; } +``` + +- *Type:* string + +The display name of the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_organization#display_name EnterpriseOrganization#display_name} + +--- + + + diff --git a/docs/enterpriseOrganization.java.md b/docs/enterpriseOrganization.java.md new file mode 100644 index 000000000..73c96a79f --- /dev/null +++ b/docs/enterpriseOrganization.java.md @@ -0,0 +1,1178 @@ +# `enterpriseOrganization` Submodule + +## Constructs + +### EnterpriseOrganization + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_organization github_enterprise_organization}. + +#### Initializers + +```java +import io.cdktn.providers.github.enterprise_organization.EnterpriseOrganization; + +EnterpriseOrganization.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .adminLogins(java.util.List) + .billingEmail(java.lang.String) + .enterpriseId(java.lang.String) + .name(java.lang.String) +// .description(java.lang.String) +// .displayName(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 | *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 | *No description.* | +| adminLogins | java.util.List | List of organization owner usernames. | +| billingEmail | java.lang.String | The billing email address. | +| enterpriseId | java.lang.String | The ID of the enterprise. | +| name | java.lang.String | The name of the organization. | +| description | java.lang.String | The description of the organization. | +| displayName | java.lang.String | The display name of the organization. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `adminLogins`Required + +- *Type:* java.util.List + +List of organization owner usernames. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_organization#admin_logins EnterpriseOrganization#admin_logins} + +--- + +##### `billingEmail`Required + +- *Type:* java.lang.String + +The billing email address. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_organization#billing_email EnterpriseOrganization#billing_email} + +--- + +##### `enterpriseId`Required + +- *Type:* java.lang.String + +The ID of the enterprise. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_organization#enterprise_id EnterpriseOrganization#enterprise_id} + +--- + +##### `name`Required + +- *Type:* java.lang.String + +The name of the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_organization#name EnterpriseOrganization#name} + +--- + +##### `description`Optional + +- *Type:* java.lang.String + +The description of the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_organization#description EnterpriseOrganization#description} + +--- + +##### `displayName`Optional + +- *Type:* java.lang.String + +The display name of the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_organization#display_name EnterpriseOrganization#display_name} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetDescription | *No description.* | +| resetDisplayName | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetDescription` + +```java +public void resetDescription() +``` + +##### `resetDisplayName` + +```java +public void resetDisplayName() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a EnterpriseOrganization resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.enterprise_organization.EnterpriseOrganization; + +EnterpriseOrganization.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` + +```java +import io.cdktn.providers.github.enterprise_organization.EnterpriseOrganization; + +EnterpriseOrganization.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.enterprise_organization.EnterpriseOrganization; + +EnterpriseOrganization.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.enterprise_organization.EnterpriseOrganization; + +EnterpriseOrganization.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),EnterpriseOrganization.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a EnterpriseOrganization 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 EnterpriseOrganization to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing EnterpriseOrganization that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_organization#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 EnterpriseOrganization 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| databaseId | java.lang.Number | *No description.* | +| id | java.lang.String | *No description.* | +| adminLoginsInput | java.util.List | *No description.* | +| billingEmailInput | java.lang.String | *No description.* | +| descriptionInput | java.lang.String | *No description.* | +| displayNameInput | java.lang.String | *No description.* | +| enterpriseIdInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| adminLogins | java.util.List | *No description.* | +| billingEmail | java.lang.String | *No description.* | +| description | java.lang.String | *No description.* | +| displayName | java.lang.String | *No description.* | +| enterpriseId | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `databaseId`Required + +```java +public java.lang.Number getDatabaseId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `adminLoginsInput`Optional + +```java +public java.util.List getAdminLoginsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `billingEmailInput`Optional + +```java +public java.lang.String getBillingEmailInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `descriptionInput`Optional + +```java +public java.lang.String getDescriptionInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `displayNameInput`Optional + +```java +public java.lang.String getDisplayNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `enterpriseIdInput`Optional + +```java +public java.lang.String getEnterpriseIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `adminLogins`Required + +```java +public java.util.List getAdminLogins(); +``` + +- *Type:* java.util.List + +--- + +##### `billingEmail`Required + +```java +public java.lang.String getBillingEmail(); +``` + +- *Type:* java.lang.String + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `displayName`Required + +```java +public java.lang.String getDisplayName(); +``` + +- *Type:* java.lang.String + +--- + +##### `enterpriseId`Required + +```java +public java.lang.String getEnterpriseId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### EnterpriseOrganizationConfig + +#### Initializer + +```java +import io.cdktn.providers.github.enterprise_organization.EnterpriseOrganizationConfig; + +EnterpriseOrganizationConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .adminLogins(java.util.List) + .billingEmail(java.lang.String) + .enterpriseId(java.lang.String) + .name(java.lang.String) +// .description(java.lang.String) +// .displayName(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 | *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 | *No description.* | +| adminLogins | java.util.List | List of organization owner usernames. | +| billingEmail | java.lang.String | The billing email address. | +| enterpriseId | java.lang.String | The ID of the enterprise. | +| name | java.lang.String | The name of the organization. | +| description | java.lang.String | The description of the organization. | +| displayName | java.lang.String | The display name of the organization. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `adminLogins`Required + +```java +public java.util.List getAdminLogins(); +``` + +- *Type:* java.util.List + +List of organization owner usernames. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_organization#admin_logins EnterpriseOrganization#admin_logins} + +--- + +##### `billingEmail`Required + +```java +public java.lang.String getBillingEmail(); +``` + +- *Type:* java.lang.String + +The billing email address. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_organization#billing_email EnterpriseOrganization#billing_email} + +--- + +##### `enterpriseId`Required + +```java +public java.lang.String getEnterpriseId(); +``` + +- *Type:* java.lang.String + +The ID of the enterprise. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_organization#enterprise_id EnterpriseOrganization#enterprise_id} + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +The name of the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_organization#name EnterpriseOrganization#name} + +--- + +##### `description`Optional + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +The description of the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_organization#description EnterpriseOrganization#description} + +--- + +##### `displayName`Optional + +```java +public java.lang.String getDisplayName(); +``` + +- *Type:* java.lang.String + +The display name of the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_organization#display_name EnterpriseOrganization#display_name} + +--- + + + diff --git a/docs/enterpriseSecurityAnalysisSettings.csharp.md b/docs/enterpriseSecurityAnalysisSettings.csharp.md new file mode 100644 index 000000000..d55c83784 --- /dev/null +++ b/docs/enterpriseSecurityAnalysisSettings.csharp.md @@ -0,0 +1,1099 @@ +# `enterpriseSecurityAnalysisSettings` Submodule + +## Constructs + +### EnterpriseSecurityAnalysisSettings + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings github_enterprise_security_analysis_settings}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new EnterpriseSecurityAnalysisSettings(Construct Scope, string Id, EnterpriseSecurityAnalysisSettingsConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | EnterpriseSecurityAnalysisSettingsConfig | *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:* EnterpriseSecurityAnalysisSettingsConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetAdvancedSecurityEnabledForNewRepositories | *No description.* | +| ResetId | *No description.* | +| ResetSecretScanningEnabledForNewRepositories | *No description.* | +| ResetSecretScanningPushProtectionCustomLink | *No description.* | +| ResetSecretScanningPushProtectionEnabledForNewRepositories | *No description.* | +| ResetSecretScanningValidityChecksEnabled | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetAdvancedSecurityEnabledForNewRepositories` + +```csharp +private void ResetAdvancedSecurityEnabledForNewRepositories() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetSecretScanningEnabledForNewRepositories` + +```csharp +private void ResetSecretScanningEnabledForNewRepositories() +``` + +##### `ResetSecretScanningPushProtectionCustomLink` + +```csharp +private void ResetSecretScanningPushProtectionCustomLink() +``` + +##### `ResetSecretScanningPushProtectionEnabledForNewRepositories` + +```csharp +private void ResetSecretScanningPushProtectionEnabledForNewRepositories() +``` + +##### `ResetSecretScanningValidityChecksEnabled` + +```csharp +private void ResetSecretScanningValidityChecksEnabled() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a EnterpriseSecurityAnalysisSettings resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseSecurityAnalysisSettings.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` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseSecurityAnalysisSettings.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseSecurityAnalysisSettings.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +EnterpriseSecurityAnalysisSettings.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a EnterpriseSecurityAnalysisSettings resource upon running "cdktn 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 EnterpriseSecurityAnalysisSettings to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing EnterpriseSecurityAnalysisSettings that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the EnterpriseSecurityAnalysisSettings to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| AdvancedSecurityEnabledForNewRepositoriesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| EnterpriseSlugInput | string | *No description.* | +| IdInput | string | *No description.* | +| SecretScanningEnabledForNewRepositoriesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| SecretScanningPushProtectionCustomLinkInput | string | *No description.* | +| SecretScanningPushProtectionEnabledForNewRepositoriesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| SecretScanningValidityChecksEnabledInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| AdvancedSecurityEnabledForNewRepositories | bool\|Io.Cdktn.IResolvable | *No description.* | +| EnterpriseSlug | string | *No description.* | +| Id | string | *No description.* | +| SecretScanningEnabledForNewRepositories | bool\|Io.Cdktn.IResolvable | *No description.* | +| SecretScanningPushProtectionCustomLink | string | *No description.* | +| SecretScanningPushProtectionEnabledForNewRepositories | bool\|Io.Cdktn.IResolvable | *No description.* | +| SecretScanningValidityChecksEnabled | bool\|Io.Cdktn.IResolvable | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `AdvancedSecurityEnabledForNewRepositoriesInput`Optional + +```csharp +public bool|IResolvable AdvancedSecurityEnabledForNewRepositoriesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `EnterpriseSlugInput`Optional + +```csharp +public string EnterpriseSlugInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `SecretScanningEnabledForNewRepositoriesInput`Optional + +```csharp +public bool|IResolvable SecretScanningEnabledForNewRepositoriesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `SecretScanningPushProtectionCustomLinkInput`Optional + +```csharp +public string SecretScanningPushProtectionCustomLinkInput { get; } +``` + +- *Type:* string + +--- + +##### `SecretScanningPushProtectionEnabledForNewRepositoriesInput`Optional + +```csharp +public bool|IResolvable SecretScanningPushProtectionEnabledForNewRepositoriesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `SecretScanningValidityChecksEnabledInput`Optional + +```csharp +public bool|IResolvable SecretScanningValidityChecksEnabledInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `AdvancedSecurityEnabledForNewRepositories`Required + +```csharp +public bool|IResolvable AdvancedSecurityEnabledForNewRepositories { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `EnterpriseSlug`Required + +```csharp +public string EnterpriseSlug { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `SecretScanningEnabledForNewRepositories`Required + +```csharp +public bool|IResolvable SecretScanningEnabledForNewRepositories { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `SecretScanningPushProtectionCustomLink`Required + +```csharp +public string SecretScanningPushProtectionCustomLink { get; } +``` + +- *Type:* string + +--- + +##### `SecretScanningPushProtectionEnabledForNewRepositories`Required + +```csharp +public bool|IResolvable SecretScanningPushProtectionEnabledForNewRepositories { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `SecretScanningValidityChecksEnabled`Required + +```csharp +public bool|IResolvable SecretScanningValidityChecksEnabled { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### EnterpriseSecurityAnalysisSettingsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new EnterpriseSecurityAnalysisSettingsConfig { + 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 EnterpriseSlug, + bool|IResolvable AdvancedSecurityEnabledForNewRepositories = null, + string Id = null, + bool|IResolvable SecretScanningEnabledForNewRepositories = null, + string SecretScanningPushProtectionCustomLink = null, + bool|IResolvable SecretScanningPushProtectionEnabledForNewRepositories = null, + bool|IResolvable SecretScanningValidityChecksEnabled = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| EnterpriseSlug | string | The slug of the enterprise. | +| AdvancedSecurityEnabledForNewRepositories | bool\|Io.Cdktn.IResolvable | Whether GitHub Advanced Security is automatically enabled for new repositories. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#id EnterpriseSecurityAnalysisSettings#id}. | +| SecretScanningEnabledForNewRepositories | bool\|Io.Cdktn.IResolvable | Whether secret scanning is automatically enabled for new repositories. | +| SecretScanningPushProtectionCustomLink | string | Custom URL for secret scanning push protection bypass instructions. | +| SecretScanningPushProtectionEnabledForNewRepositories | bool\|Io.Cdktn.IResolvable | Whether secret scanning push protection is automatically enabled for new repositories. | +| SecretScanningValidityChecksEnabled | bool\|Io.Cdktn.IResolvable | Whether secret scanning validity checks are enabled. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `EnterpriseSlug`Required + +```csharp +public string EnterpriseSlug { get; set; } +``` + +- *Type:* string + +The slug of the enterprise. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#enterprise_slug EnterpriseSecurityAnalysisSettings#enterprise_slug} + +--- + +##### `AdvancedSecurityEnabledForNewRepositories`Optional + +```csharp +public bool|IResolvable AdvancedSecurityEnabledForNewRepositories { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether GitHub Advanced Security is automatically enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#advanced_security_enabled_for_new_repositories EnterpriseSecurityAnalysisSettings#advanced_security_enabled_for_new_repositories} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#id EnterpriseSecurityAnalysisSettings#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. + +--- + +##### `SecretScanningEnabledForNewRepositories`Optional + +```csharp +public bool|IResolvable SecretScanningEnabledForNewRepositories { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether secret scanning is automatically enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#secret_scanning_enabled_for_new_repositories EnterpriseSecurityAnalysisSettings#secret_scanning_enabled_for_new_repositories} + +--- + +##### `SecretScanningPushProtectionCustomLink`Optional + +```csharp +public string SecretScanningPushProtectionCustomLink { get; set; } +``` + +- *Type:* string + +Custom URL for secret scanning push protection bypass instructions. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#secret_scanning_push_protection_custom_link EnterpriseSecurityAnalysisSettings#secret_scanning_push_protection_custom_link} + +--- + +##### `SecretScanningPushProtectionEnabledForNewRepositories`Optional + +```csharp +public bool|IResolvable SecretScanningPushProtectionEnabledForNewRepositories { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether secret scanning push protection is automatically enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#secret_scanning_push_protection_enabled_for_new_repositories EnterpriseSecurityAnalysisSettings#secret_scanning_push_protection_enabled_for_new_repositories} + +--- + +##### `SecretScanningValidityChecksEnabled`Optional + +```csharp +public bool|IResolvable SecretScanningValidityChecksEnabled { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether secret scanning validity checks are enabled. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#secret_scanning_validity_checks_enabled EnterpriseSecurityAnalysisSettings#secret_scanning_validity_checks_enabled} + +--- + + + diff --git a/docs/enterpriseSecurityAnalysisSettings.java.md b/docs/enterpriseSecurityAnalysisSettings.java.md new file mode 100644 index 000000000..cda557cf3 --- /dev/null +++ b/docs/enterpriseSecurityAnalysisSettings.java.md @@ -0,0 +1,1236 @@ +# `enterpriseSecurityAnalysisSettings` Submodule + +## Constructs + +### EnterpriseSecurityAnalysisSettings + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings github_enterprise_security_analysis_settings}. + +#### Initializers + +```java +import io.cdktn.providers.github.enterprise_security_analysis_settings.EnterpriseSecurityAnalysisSettings; + +EnterpriseSecurityAnalysisSettings.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .enterpriseSlug(java.lang.String) +// .advancedSecurityEnabledForNewRepositories(java.lang.Boolean|IResolvable) +// .id(java.lang.String) +// .secretScanningEnabledForNewRepositories(java.lang.Boolean|IResolvable) +// .secretScanningPushProtectionCustomLink(java.lang.String) +// .secretScanningPushProtectionEnabledForNewRepositories(java.lang.Boolean|IResolvable) +// .secretScanningValidityChecksEnabled(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 | *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 | *No description.* | +| enterpriseSlug | java.lang.String | The slug of the enterprise. | +| advancedSecurityEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether GitHub Advanced Security is automatically enabled for new repositories. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#id EnterpriseSecurityAnalysisSettings#id}. | +| secretScanningEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether secret scanning is automatically enabled for new repositories. | +| secretScanningPushProtectionCustomLink | java.lang.String | Custom URL for secret scanning push protection bypass instructions. | +| secretScanningPushProtectionEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether secret scanning push protection is automatically enabled for new repositories. | +| secretScanningValidityChecksEnabled | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether secret scanning validity checks are enabled. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `enterpriseSlug`Required + +- *Type:* java.lang.String + +The slug of the enterprise. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#enterprise_slug EnterpriseSecurityAnalysisSettings#enterprise_slug} + +--- + +##### `advancedSecurityEnabledForNewRepositories`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether GitHub Advanced Security is automatically enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#advanced_security_enabled_for_new_repositories EnterpriseSecurityAnalysisSettings#advanced_security_enabled_for_new_repositories} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#id EnterpriseSecurityAnalysisSettings#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. + +--- + +##### `secretScanningEnabledForNewRepositories`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether secret scanning is automatically enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#secret_scanning_enabled_for_new_repositories EnterpriseSecurityAnalysisSettings#secret_scanning_enabled_for_new_repositories} + +--- + +##### `secretScanningPushProtectionCustomLink`Optional + +- *Type:* java.lang.String + +Custom URL for secret scanning push protection bypass instructions. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#secret_scanning_push_protection_custom_link EnterpriseSecurityAnalysisSettings#secret_scanning_push_protection_custom_link} + +--- + +##### `secretScanningPushProtectionEnabledForNewRepositories`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether secret scanning push protection is automatically enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#secret_scanning_push_protection_enabled_for_new_repositories EnterpriseSecurityAnalysisSettings#secret_scanning_push_protection_enabled_for_new_repositories} + +--- + +##### `secretScanningValidityChecksEnabled`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether secret scanning validity checks are enabled. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#secret_scanning_validity_checks_enabled EnterpriseSecurityAnalysisSettings#secret_scanning_validity_checks_enabled} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetAdvancedSecurityEnabledForNewRepositories | *No description.* | +| resetId | *No description.* | +| resetSecretScanningEnabledForNewRepositories | *No description.* | +| resetSecretScanningPushProtectionCustomLink | *No description.* | +| resetSecretScanningPushProtectionEnabledForNewRepositories | *No description.* | +| resetSecretScanningValidityChecksEnabled | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetAdvancedSecurityEnabledForNewRepositories` + +```java +public void resetAdvancedSecurityEnabledForNewRepositories() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetSecretScanningEnabledForNewRepositories` + +```java +public void resetSecretScanningEnabledForNewRepositories() +``` + +##### `resetSecretScanningPushProtectionCustomLink` + +```java +public void resetSecretScanningPushProtectionCustomLink() +``` + +##### `resetSecretScanningPushProtectionEnabledForNewRepositories` + +```java +public void resetSecretScanningPushProtectionEnabledForNewRepositories() +``` + +##### `resetSecretScanningValidityChecksEnabled` + +```java +public void resetSecretScanningValidityChecksEnabled() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a EnterpriseSecurityAnalysisSettings resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.enterprise_security_analysis_settings.EnterpriseSecurityAnalysisSettings; + +EnterpriseSecurityAnalysisSettings.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` + +```java +import io.cdktn.providers.github.enterprise_security_analysis_settings.EnterpriseSecurityAnalysisSettings; + +EnterpriseSecurityAnalysisSettings.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.enterprise_security_analysis_settings.EnterpriseSecurityAnalysisSettings; + +EnterpriseSecurityAnalysisSettings.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.enterprise_security_analysis_settings.EnterpriseSecurityAnalysisSettings; + +EnterpriseSecurityAnalysisSettings.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),EnterpriseSecurityAnalysisSettings.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a EnterpriseSecurityAnalysisSettings 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 EnterpriseSecurityAnalysisSettings to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing EnterpriseSecurityAnalysisSettings that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#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 EnterpriseSecurityAnalysisSettings 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| advancedSecurityEnabledForNewRepositoriesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| enterpriseSlugInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| secretScanningEnabledForNewRepositoriesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| secretScanningPushProtectionCustomLinkInput | java.lang.String | *No description.* | +| secretScanningPushProtectionEnabledForNewRepositoriesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| secretScanningValidityChecksEnabledInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| advancedSecurityEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| enterpriseSlug | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| secretScanningEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| secretScanningPushProtectionCustomLink | java.lang.String | *No description.* | +| secretScanningPushProtectionEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| secretScanningValidityChecksEnabled | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `advancedSecurityEnabledForNewRepositoriesInput`Optional + +```java +public java.lang.Boolean|IResolvable getAdvancedSecurityEnabledForNewRepositoriesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `enterpriseSlugInput`Optional + +```java +public java.lang.String getEnterpriseSlugInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretScanningEnabledForNewRepositoriesInput`Optional + +```java +public java.lang.Boolean|IResolvable getSecretScanningEnabledForNewRepositoriesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `secretScanningPushProtectionCustomLinkInput`Optional + +```java +public java.lang.String getSecretScanningPushProtectionCustomLinkInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretScanningPushProtectionEnabledForNewRepositoriesInput`Optional + +```java +public java.lang.Boolean|IResolvable getSecretScanningPushProtectionEnabledForNewRepositoriesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `secretScanningValidityChecksEnabledInput`Optional + +```java +public java.lang.Boolean|IResolvable getSecretScanningValidityChecksEnabledInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `advancedSecurityEnabledForNewRepositories`Required + +```java +public java.lang.Boolean|IResolvable getAdvancedSecurityEnabledForNewRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `enterpriseSlug`Required + +```java +public java.lang.String getEnterpriseSlug(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretScanningEnabledForNewRepositories`Required + +```java +public java.lang.Boolean|IResolvable getSecretScanningEnabledForNewRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `secretScanningPushProtectionCustomLink`Required + +```java +public java.lang.String getSecretScanningPushProtectionCustomLink(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretScanningPushProtectionEnabledForNewRepositories`Required + +```java +public java.lang.Boolean|IResolvable getSecretScanningPushProtectionEnabledForNewRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `secretScanningValidityChecksEnabled`Required + +```java +public java.lang.Boolean|IResolvable getSecretScanningValidityChecksEnabled(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### EnterpriseSecurityAnalysisSettingsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.enterprise_security_analysis_settings.EnterpriseSecurityAnalysisSettingsConfig; + +EnterpriseSecurityAnalysisSettingsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .enterpriseSlug(java.lang.String) +// .advancedSecurityEnabledForNewRepositories(java.lang.Boolean|IResolvable) +// .id(java.lang.String) +// .secretScanningEnabledForNewRepositories(java.lang.Boolean|IResolvable) +// .secretScanningPushProtectionCustomLink(java.lang.String) +// .secretScanningPushProtectionEnabledForNewRepositories(java.lang.Boolean|IResolvable) +// .secretScanningValidityChecksEnabled(java.lang.Boolean|IResolvable) + .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 | *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 | *No description.* | +| enterpriseSlug | java.lang.String | The slug of the enterprise. | +| advancedSecurityEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether GitHub Advanced Security is automatically enabled for new repositories. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#id EnterpriseSecurityAnalysisSettings#id}. | +| secretScanningEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether secret scanning is automatically enabled for new repositories. | +| secretScanningPushProtectionCustomLink | java.lang.String | Custom URL for secret scanning push protection bypass instructions. | +| secretScanningPushProtectionEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether secret scanning push protection is automatically enabled for new repositories. | +| secretScanningValidityChecksEnabled | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether secret scanning validity checks are enabled. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `enterpriseSlug`Required + +```java +public java.lang.String getEnterpriseSlug(); +``` + +- *Type:* java.lang.String + +The slug of the enterprise. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#enterprise_slug EnterpriseSecurityAnalysisSettings#enterprise_slug} + +--- + +##### `advancedSecurityEnabledForNewRepositories`Optional + +```java +public java.lang.Boolean|IResolvable getAdvancedSecurityEnabledForNewRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether GitHub Advanced Security is automatically enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#advanced_security_enabled_for_new_repositories EnterpriseSecurityAnalysisSettings#advanced_security_enabled_for_new_repositories} + +--- + +##### `id`Optional + +```java +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/resources/enterprise_security_analysis_settings#id EnterpriseSecurityAnalysisSettings#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. + +--- + +##### `secretScanningEnabledForNewRepositories`Optional + +```java +public java.lang.Boolean|IResolvable getSecretScanningEnabledForNewRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether secret scanning is automatically enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#secret_scanning_enabled_for_new_repositories EnterpriseSecurityAnalysisSettings#secret_scanning_enabled_for_new_repositories} + +--- + +##### `secretScanningPushProtectionCustomLink`Optional + +```java +public java.lang.String getSecretScanningPushProtectionCustomLink(); +``` + +- *Type:* java.lang.String + +Custom URL for secret scanning push protection bypass instructions. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#secret_scanning_push_protection_custom_link EnterpriseSecurityAnalysisSettings#secret_scanning_push_protection_custom_link} + +--- + +##### `secretScanningPushProtectionEnabledForNewRepositories`Optional + +```java +public java.lang.Boolean|IResolvable getSecretScanningPushProtectionEnabledForNewRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether secret scanning push protection is automatically enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#secret_scanning_push_protection_enabled_for_new_repositories EnterpriseSecurityAnalysisSettings#secret_scanning_push_protection_enabled_for_new_repositories} + +--- + +##### `secretScanningValidityChecksEnabled`Optional + +```java +public java.lang.Boolean|IResolvable getSecretScanningValidityChecksEnabled(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether secret scanning validity checks are enabled. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/enterprise_security_analysis_settings#secret_scanning_validity_checks_enabled EnterpriseSecurityAnalysisSettings#secret_scanning_validity_checks_enabled} + +--- + + + diff --git a/docs/issue.csharp.md b/docs/issue.csharp.md new file mode 100644 index 000000000..a934dfb36 --- /dev/null +++ b/docs/issue.csharp.md @@ -0,0 +1,1125 @@ +# `issue` Submodule + +## Constructs + +### Issue + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue github_issue}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new Issue(Construct Scope, string Id, IssueConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | IssueConfig | *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:* IssueConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetAssignees | *No description.* | +| ResetBody | *No description.* | +| ResetId | *No description.* | +| ResetLabels | *No description.* | +| ResetMilestoneNumber | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetAssignees` + +```csharp +private void ResetAssignees() +``` + +##### `ResetBody` + +```csharp +private void ResetBody() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetLabels` + +```csharp +private void ResetLabels() +``` + +##### `ResetMilestoneNumber` + +```csharp +private void ResetMilestoneNumber() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a Issue resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +Issue.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` + +```csharp +using Io.Cdktn.Providers.Github; + +Issue.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +Issue.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +Issue.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a Issue resource upon running "cdktn 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 Issue to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing Issue that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the Issue to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Etag | string | *No description.* | +| IssueId | double | *No description.* | +| Number | double | *No description.* | +| AssigneesInput | string[] | *No description.* | +| BodyInput | string | *No description.* | +| IdInput | string | *No description.* | +| LabelsInput | string[] | *No description.* | +| MilestoneNumberInput | double | *No description.* | +| RepositoryInput | string | *No description.* | +| TitleInput | string | *No description.* | +| Assignees | string[] | *No description.* | +| Body | string | *No description.* | +| Id | string | *No description.* | +| Labels | string[] | *No description.* | +| MilestoneNumber | double | *No description.* | +| Repository | string | *No description.* | +| Title | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `IssueId`Required + +```csharp +public double IssueId { get; } +``` + +- *Type:* double + +--- + +##### `Number`Required + +```csharp +public double Number { get; } +``` + +- *Type:* double + +--- + +##### `AssigneesInput`Optional + +```csharp +public string[] AssigneesInput { get; } +``` + +- *Type:* string[] + +--- + +##### `BodyInput`Optional + +```csharp +public string BodyInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `LabelsInput`Optional + +```csharp +public string[] LabelsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `MilestoneNumberInput`Optional + +```csharp +public double MilestoneNumberInput { get; } +``` + +- *Type:* double + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `TitleInput`Optional + +```csharp +public string TitleInput { get; } +``` + +- *Type:* string + +--- + +##### `Assignees`Required + +```csharp +public string[] Assignees { get; } +``` + +- *Type:* string[] + +--- + +##### `Body`Required + +```csharp +public string Body { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Labels`Required + +```csharp +public string[] Labels { get; } +``` + +- *Type:* string[] + +--- + +##### `MilestoneNumber`Required + +```csharp +public double MilestoneNumber { get; } +``` + +- *Type:* double + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `Title`Required + +```csharp +public string Title { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### IssueConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new IssueConfig { + 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 Repository, + string Title, + string[] Assignees = null, + string Body = null, + string Id = null, + string[] Labels = null, + double MilestoneNumber = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | The GitHub repository name. | +| Title | string | Title of the issue. | +| Assignees | string[] | List of Logins to assign to the issue. | +| Body | string | Body of the issue. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#id Issue#id}. | +| Labels | string[] | List of labels to attach to the issue. | +| MilestoneNumber | double | Milestone number to assign to the issue. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The GitHub repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#repository Issue#repository} + +--- + +##### `Title`Required + +```csharp +public string Title { get; set; } +``` + +- *Type:* string + +Title of the issue. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#title Issue#title} + +--- + +##### `Assignees`Optional + +```csharp +public string[] Assignees { get; set; } +``` + +- *Type:* string[] + +List of Logins to assign to the issue. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#assignees Issue#assignees} + +--- + +##### `Body`Optional + +```csharp +public string Body { get; set; } +``` + +- *Type:* string + +Body of the issue. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#body Issue#body} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#id Issue#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. + +--- + +##### `Labels`Optional + +```csharp +public string[] Labels { get; set; } +``` + +- *Type:* string[] + +List of labels to attach to the issue. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#labels Issue#labels} + +--- + +##### `MilestoneNumber`Optional + +```csharp +public double MilestoneNumber { get; set; } +``` + +- *Type:* double + +Milestone number to assign to the issue. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#milestone_number Issue#milestone_number} + +--- + + + diff --git a/docs/issue.java.md b/docs/issue.java.md new file mode 100644 index 000000000..5d87c56d7 --- /dev/null +++ b/docs/issue.java.md @@ -0,0 +1,1262 @@ +# `issue` Submodule + +## Constructs + +### Issue + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue github_issue}. + +#### Initializers + +```java +import io.cdktn.providers.github.issue.Issue; + +Issue.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) + .title(java.lang.String) +// .assignees(java.util.List) +// .body(java.lang.String) +// .id(java.lang.String) +// .labels(java.util.List) +// .milestoneNumber(java.lang.Number) + .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 | *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 | *No description.* | +| repository | java.lang.String | The GitHub repository name. | +| title | java.lang.String | Title of the issue. | +| assignees | java.util.List | List of Logins to assign to the issue. | +| body | java.lang.String | Body of the issue. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#id Issue#id}. | +| labels | java.util.List | List of labels to attach to the issue. | +| milestoneNumber | java.lang.Number | Milestone number to assign to the issue. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The GitHub repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#repository Issue#repository} + +--- + +##### `title`Required + +- *Type:* java.lang.String + +Title of the issue. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#title Issue#title} + +--- + +##### `assignees`Optional + +- *Type:* java.util.List + +List of Logins to assign to the issue. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#assignees Issue#assignees} + +--- + +##### `body`Optional + +- *Type:* java.lang.String + +Body of the issue. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#body Issue#body} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#id Issue#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. + +--- + +##### `labels`Optional + +- *Type:* java.util.List + +List of labels to attach to the issue. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#labels Issue#labels} + +--- + +##### `milestoneNumber`Optional + +- *Type:* java.lang.Number + +Milestone number to assign to the issue. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#milestone_number Issue#milestone_number} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetAssignees | *No description.* | +| resetBody | *No description.* | +| resetId | *No description.* | +| resetLabels | *No description.* | +| resetMilestoneNumber | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetAssignees` + +```java +public void resetAssignees() +``` + +##### `resetBody` + +```java +public void resetBody() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetLabels` + +```java +public void resetLabels() +``` + +##### `resetMilestoneNumber` + +```java +public void resetMilestoneNumber() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a Issue resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.issue.Issue; + +Issue.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` + +```java +import io.cdktn.providers.github.issue.Issue; + +Issue.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.issue.Issue; + +Issue.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.issue.Issue; + +Issue.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),Issue.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a Issue 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 Issue to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing Issue that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#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 Issue 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| etag | java.lang.String | *No description.* | +| issueId | java.lang.Number | *No description.* | +| number | java.lang.Number | *No description.* | +| assigneesInput | java.util.List | *No description.* | +| bodyInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| labelsInput | java.util.List | *No description.* | +| milestoneNumberInput | java.lang.Number | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| titleInput | java.lang.String | *No description.* | +| assignees | java.util.List | *No description.* | +| body | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| labels | java.util.List | *No description.* | +| milestoneNumber | java.lang.Number | *No description.* | +| repository | java.lang.String | *No description.* | +| title | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `issueId`Required + +```java +public java.lang.Number getIssueId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `number`Required + +```java +public java.lang.Number getNumber(); +``` + +- *Type:* java.lang.Number + +--- + +##### `assigneesInput`Optional + +```java +public java.util.List getAssigneesInput(); +``` + +- *Type:* java.util.List + +--- + +##### `bodyInput`Optional + +```java +public java.lang.String getBodyInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `labelsInput`Optional + +```java +public java.util.List getLabelsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `milestoneNumberInput`Optional + +```java +public java.lang.Number getMilestoneNumberInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `titleInput`Optional + +```java +public java.lang.String getTitleInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `assignees`Required + +```java +public java.util.List getAssignees(); +``` + +- *Type:* java.util.List + +--- + +##### `body`Required + +```java +public java.lang.String getBody(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `labels`Required + +```java +public java.util.List getLabels(); +``` + +- *Type:* java.util.List + +--- + +##### `milestoneNumber`Required + +```java +public java.lang.Number getMilestoneNumber(); +``` + +- *Type:* java.lang.Number + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `title`Required + +```java +public java.lang.String getTitle(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### IssueConfig + +#### Initializer + +```java +import io.cdktn.providers.github.issue.IssueConfig; + +IssueConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) + .title(java.lang.String) +// .assignees(java.util.List) +// .body(java.lang.String) +// .id(java.lang.String) +// .labels(java.util.List) +// .milestoneNumber(java.lang.Number) + .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 | *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 | *No description.* | +| repository | java.lang.String | The GitHub repository name. | +| title | java.lang.String | Title of the issue. | +| assignees | java.util.List | List of Logins to assign to the issue. | +| body | java.lang.String | Body of the issue. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#id Issue#id}. | +| labels | java.util.List | List of labels to attach to the issue. | +| milestoneNumber | java.lang.Number | Milestone number to assign to the issue. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The GitHub repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#repository Issue#repository} + +--- + +##### `title`Required + +```java +public java.lang.String getTitle(); +``` + +- *Type:* java.lang.String + +Title of the issue. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#title Issue#title} + +--- + +##### `assignees`Optional + +```java +public java.util.List getAssignees(); +``` + +- *Type:* java.util.List + +List of Logins to assign to the issue. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#assignees Issue#assignees} + +--- + +##### `body`Optional + +```java +public java.lang.String getBody(); +``` + +- *Type:* java.lang.String + +Body of the issue. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#body Issue#body} + +--- + +##### `id`Optional + +```java +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/resources/issue#id Issue#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. + +--- + +##### `labels`Optional + +```java +public java.util.List getLabels(); +``` + +- *Type:* java.util.List + +List of labels to attach to the issue. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#labels Issue#labels} + +--- + +##### `milestoneNumber`Optional + +```java +public java.lang.Number getMilestoneNumber(); +``` + +- *Type:* java.lang.Number + +Milestone number to assign to the issue. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue#milestone_number Issue#milestone_number} + +--- + + + diff --git a/docs/issueLabel.csharp.md b/docs/issueLabel.csharp.md new file mode 100644 index 000000000..7a9145540 --- /dev/null +++ b/docs/issueLabel.csharp.md @@ -0,0 +1,1049 @@ +# `issueLabel` Submodule + +## Constructs + +### IssueLabel + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label github_issue_label}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new IssueLabel(Construct Scope, string Id, IssueLabelConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | IssueLabelConfig | *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:* IssueLabelConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetDescription | *No description.* | +| ResetEtag | *No description.* | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetDescription` + +```csharp +private void ResetDescription() +``` + +##### `ResetEtag` + +```csharp +private void ResetEtag() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a IssueLabel resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +IssueLabel.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` + +```csharp +using Io.Cdktn.Providers.Github; + +IssueLabel.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +IssueLabel.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +IssueLabel.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a IssueLabel resource upon running "cdktn 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 IssueLabel to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing IssueLabel that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the IssueLabel to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Url | string | *No description.* | +| ColorInput | string | *No description.* | +| DescriptionInput | string | *No description.* | +| EtagInput | string | *No description.* | +| IdInput | string | *No description.* | +| NameInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Color | string | *No description.* | +| Description | string | *No description.* | +| Etag | string | *No description.* | +| Id | string | *No description.* | +| Name | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Url`Required + +```csharp +public string Url { get; } +``` + +- *Type:* string + +--- + +##### `ColorInput`Optional + +```csharp +public string ColorInput { get; } +``` + +- *Type:* string + +--- + +##### `DescriptionInput`Optional + +```csharp +public string DescriptionInput { get; } +``` + +- *Type:* string + +--- + +##### `EtagInput`Optional + +```csharp +public string EtagInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Color`Required + +```csharp +public string Color { get; } +``` + +- *Type:* string + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### IssueLabelConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new IssueLabelConfig { + 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 Color, + string Name, + string Repository, + string Description = null, + string Etag = null, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Color | string | A 6 character hex code, without the leading '#', identifying the color of the label. | +| Name | string | The name of the label. | +| Repository | string | The GitHub repository. | +| Description | string | A short description of the label. | +| Etag | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#etag IssueLabel#etag}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#id IssueLabel#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Color`Required + +```csharp +public string Color { get; set; } +``` + +- *Type:* string + +A 6 character hex code, without the leading '#', identifying the color of the label. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#color IssueLabel#color} + +--- + +##### `Name`Required + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +The name of the label. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#name IssueLabel#name} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#repository IssueLabel#repository} + +--- + +##### `Description`Optional + +```csharp +public string Description { get; set; } +``` + +- *Type:* string + +A short description of the label. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#description IssueLabel#description} + +--- + +##### `Etag`Optional + +```csharp +public string Etag { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#etag IssueLabel#etag}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#id IssueLabel#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. + +--- + + + diff --git a/docs/issueLabel.java.md b/docs/issueLabel.java.md new file mode 100644 index 000000000..2680d12e5 --- /dev/null +++ b/docs/issueLabel.java.md @@ -0,0 +1,1172 @@ +# `issueLabel` Submodule + +## Constructs + +### IssueLabel + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label github_issue_label}. + +#### Initializers + +```java +import io.cdktn.providers.github.issue_label.IssueLabel; + +IssueLabel.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .color(java.lang.String) + .name(java.lang.String) + .repository(java.lang.String) +// .description(java.lang.String) +// .etag(java.lang.String) +// .id(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 | *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 | *No description.* | +| color | java.lang.String | A 6 character hex code, without the leading '#', identifying the color of the label. | +| name | java.lang.String | The name of the label. | +| repository | java.lang.String | The GitHub repository. | +| description | java.lang.String | A short description of the label. | +| etag | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#etag IssueLabel#etag}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#id IssueLabel#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `color`Required + +- *Type:* java.lang.String + +A 6 character hex code, without the leading '#', identifying the color of the label. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#color IssueLabel#color} + +--- + +##### `name`Required + +- *Type:* java.lang.String + +The name of the label. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#name IssueLabel#name} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#repository IssueLabel#repository} + +--- + +##### `description`Optional + +- *Type:* java.lang.String + +A short description of the label. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#description IssueLabel#description} + +--- + +##### `etag`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#etag IssueLabel#etag}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#id IssueLabel#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetDescription | *No description.* | +| resetEtag | *No description.* | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetDescription` + +```java +public void resetDescription() +``` + +##### `resetEtag` + +```java +public void resetEtag() +``` + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a IssueLabel resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.issue_label.IssueLabel; + +IssueLabel.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` + +```java +import io.cdktn.providers.github.issue_label.IssueLabel; + +IssueLabel.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.issue_label.IssueLabel; + +IssueLabel.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.issue_label.IssueLabel; + +IssueLabel.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),IssueLabel.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a IssueLabel 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 IssueLabel to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing IssueLabel that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#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 IssueLabel 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| url | java.lang.String | *No description.* | +| colorInput | java.lang.String | *No description.* | +| descriptionInput | java.lang.String | *No description.* | +| etagInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| color | java.lang.String | *No description.* | +| description | java.lang.String | *No description.* | +| etag | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `colorInput`Optional + +```java +public java.lang.String getColorInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `descriptionInput`Optional + +```java +public java.lang.String getDescriptionInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `etagInput`Optional + +```java +public java.lang.String getEtagInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `color`Required + +```java +public java.lang.String getColor(); +``` + +- *Type:* java.lang.String + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### IssueLabelConfig + +#### Initializer + +```java +import io.cdktn.providers.github.issue_label.IssueLabelConfig; + +IssueLabelConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .color(java.lang.String) + .name(java.lang.String) + .repository(java.lang.String) +// .description(java.lang.String) +// .etag(java.lang.String) +// .id(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 | *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 | *No description.* | +| color | java.lang.String | A 6 character hex code, without the leading '#', identifying the color of the label. | +| name | java.lang.String | The name of the label. | +| repository | java.lang.String | The GitHub repository. | +| description | java.lang.String | A short description of the label. | +| etag | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#etag IssueLabel#etag}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#id IssueLabel#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `color`Required + +```java +public java.lang.String getColor(); +``` + +- *Type:* java.lang.String + +A 6 character hex code, without the leading '#', identifying the color of the label. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#color IssueLabel#color} + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +The name of the label. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#name IssueLabel#name} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#repository IssueLabel#repository} + +--- + +##### `description`Optional + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +A short description of the label. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#description IssueLabel#description} + +--- + +##### `etag`Optional + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_label#etag IssueLabel#etag}. + +--- + +##### `id`Optional + +```java +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/resources/issue_label#id IssueLabel#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. + +--- + + + diff --git a/docs/issueLabels.csharp.md b/docs/issueLabels.csharp.md new file mode 100644 index 000000000..ba8aad3e0 --- /dev/null +++ b/docs/issueLabels.csharp.md @@ -0,0 +1,1510 @@ +# `issueLabels` Submodule + +## Constructs + +### IssueLabels + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_labels github_issue_labels}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new IssueLabels(Construct Scope, string Id, IssueLabelsConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | IssueLabelsConfig | *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:* IssueLabelsConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| PutLabel | *No description.* | +| ResetId | *No description.* | +| ResetLabel | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `PutLabel` + +```csharp +private void PutLabel(IResolvable|IssueLabelsLabel[] Value) +``` + +###### `Value`Required + +- *Type:* Io.Cdktn.IResolvable|IssueLabelsLabel[] + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetLabel` + +```csharp +private void ResetLabel() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a IssueLabels resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +IssueLabels.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` + +```csharp +using Io.Cdktn.Providers.Github; + +IssueLabels.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +IssueLabels.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +IssueLabels.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a IssueLabels resource upon running "cdktn 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 IssueLabels to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing IssueLabels that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_labels#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the IssueLabels to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Label | IssueLabelsLabelList | *No description.* | +| IdInput | string | *No description.* | +| LabelInput | Io.Cdktn.IResolvable\|IssueLabelsLabel[] | *No description.* | +| RepositoryInput | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Label`Required + +```csharp +public IssueLabelsLabelList Label { get; } +``` + +- *Type:* IssueLabelsLabelList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `LabelInput`Optional + +```csharp +public IResolvable|IssueLabelsLabel[] LabelInput { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|IssueLabelsLabel[] + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### IssueLabelsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new IssueLabelsConfig { + 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 Repository, + string Id = null, + IResolvable|IssueLabelsLabel[] Label = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | The GitHub repository. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_labels#id IssueLabels#id}. | +| Label | Io.Cdktn.IResolvable\|IssueLabelsLabel[] | label block. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_labels#repository IssueLabels#repository} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_labels#id IssueLabels#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. + +--- + +##### `Label`Optional + +```csharp +public IResolvable|IssueLabelsLabel[] Label { get; set; } +``` + +- *Type:* Io.Cdktn.IResolvable|IssueLabelsLabel[] + +label block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_labels#label IssueLabels#label} + +--- + +### IssueLabelsLabel + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new IssueLabelsLabel { + string Color, + string Name, + string Description = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Color | string | A 6 character hex code, without the leading '#', identifying the color of the label. | +| Name | string | The name of the label. | +| Description | string | A short description of the label. | + +--- + +##### `Color`Required + +```csharp +public string Color { get; set; } +``` + +- *Type:* string + +A 6 character hex code, without the leading '#', identifying the color of the label. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_labels#color IssueLabels#color} + +--- + +##### `Name`Required + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +The name of the label. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_labels#name IssueLabels#name} + +--- + +##### `Description`Optional + +```csharp +public string Description { get; set; } +``` + +- *Type:* string + +A short description of the label. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_labels#description IssueLabels#description} + +--- + +## Classes + +### IssueLabelsLabelList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new IssueLabelsLabelList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private IssueLabelsLabelOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|IssueLabelsLabel[] | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|IssueLabelsLabel[] InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|IssueLabelsLabel[] + +--- + + +### IssueLabelsLabelOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new IssueLabelsLabelOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetDescription | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetDescription` + +```csharp +private void ResetDescription() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Url | string | *No description.* | +| ColorInput | string | *No description.* | +| DescriptionInput | string | *No description.* | +| NameInput | string | *No description.* | +| Color | string | *No description.* | +| Description | string | *No description.* | +| Name | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|IssueLabelsLabel | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Url`Required + +```csharp +public string Url { get; } +``` + +- *Type:* string + +--- + +##### `ColorInput`Optional + +```csharp +public string ColorInput { get; } +``` + +- *Type:* string + +--- + +##### `DescriptionInput`Optional + +```csharp +public string DescriptionInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `Color`Required + +```csharp +public string Color { get; } +``` + +- *Type:* string + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|IssueLabelsLabel InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|IssueLabelsLabel + +--- + + + diff --git a/docs/issueLabels.java.md b/docs/issueLabels.java.md new file mode 100644 index 000000000..27df32bfc --- /dev/null +++ b/docs/issueLabels.java.md @@ -0,0 +1,1599 @@ +# `issueLabels` Submodule + +## Constructs + +### IssueLabels + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_labels github_issue_labels}. + +#### Initializers + +```java +import io.cdktn.providers.github.issue_labels.IssueLabels; + +IssueLabels.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(java.lang.String) +// .label(IResolvable|java.util.List) + .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 | *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 | *No description.* | +| repository | java.lang.String | The GitHub repository. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_labels#id IssueLabels#id}. | +| label | io.cdktn.cdktn.IResolvable\|java.util.List<IssueLabelsLabel> | label block. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_labels#repository IssueLabels#repository} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_labels#id IssueLabels#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. + +--- + +##### `label`Optional + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<IssueLabelsLabel> + +label block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_labels#label IssueLabels#label} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| putLabel | *No description.* | +| resetId | *No description.* | +| resetLabel | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `putLabel` + +```java +public void putLabel(IResolvable|java.util.List value) +``` + +###### `value`Required + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<IssueLabelsLabel> + +--- + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetLabel` + +```java +public void resetLabel() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a IssueLabels resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.issue_labels.IssueLabels; + +IssueLabels.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` + +```java +import io.cdktn.providers.github.issue_labels.IssueLabels; + +IssueLabels.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.issue_labels.IssueLabels; + +IssueLabels.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.issue_labels.IssueLabels; + +IssueLabels.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),IssueLabels.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a IssueLabels 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 IssueLabels to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing IssueLabels that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_labels#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 IssueLabels 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| label | IssueLabelsLabelList | *No description.* | +| idInput | java.lang.String | *No description.* | +| labelInput | io.cdktn.cdktn.IResolvable\|java.util.List<IssueLabelsLabel> | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `label`Required + +```java +public IssueLabelsLabelList getLabel(); +``` + +- *Type:* IssueLabelsLabelList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `labelInput`Optional + +```java +public IResolvable|java.util.List getLabelInput(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<IssueLabelsLabel> + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### IssueLabelsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.issue_labels.IssueLabelsConfig; + +IssueLabelsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(java.lang.String) +// .label(IResolvable|java.util.List) + .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 | *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 | *No description.* | +| repository | java.lang.String | The GitHub repository. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_labels#id IssueLabels#id}. | +| label | io.cdktn.cdktn.IResolvable\|java.util.List<IssueLabelsLabel> | label block. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_labels#repository IssueLabels#repository} + +--- + +##### `id`Optional + +```java +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/resources/issue_labels#id IssueLabels#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. + +--- + +##### `label`Optional + +```java +public IResolvable|java.util.List getLabel(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<IssueLabelsLabel> + +label block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_labels#label IssueLabels#label} + +--- + +### IssueLabelsLabel + +#### Initializer + +```java +import io.cdktn.providers.github.issue_labels.IssueLabelsLabel; + +IssueLabelsLabel.builder() + .color(java.lang.String) + .name(java.lang.String) +// .description(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| color | java.lang.String | A 6 character hex code, without the leading '#', identifying the color of the label. | +| name | java.lang.String | The name of the label. | +| description | java.lang.String | A short description of the label. | + +--- + +##### `color`Required + +```java +public java.lang.String getColor(); +``` + +- *Type:* java.lang.String + +A 6 character hex code, without the leading '#', identifying the color of the label. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_labels#color IssueLabels#color} + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +The name of the label. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_labels#name IssueLabels#name} + +--- + +##### `description`Optional + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +A short description of the label. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/issue_labels#description IssueLabels#description} + +--- + +## Classes + +### IssueLabelsLabelList + +#### Initializers + +```java +import io.cdktn.providers.github.issue_labels.IssueLabelsLabelList; + +new IssueLabelsLabelList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public IssueLabelsLabelOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|java.util.List<IssueLabelsLabel> | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|java.util.List getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<IssueLabelsLabel> + +--- + + +### IssueLabelsLabelOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.issue_labels.IssueLabelsLabelOutputReference; + +new IssueLabelsLabelOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetDescription | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetDescription` + +```java +public void resetDescription() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| url | java.lang.String | *No description.* | +| colorInput | java.lang.String | *No description.* | +| descriptionInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| color | java.lang.String | *No description.* | +| description | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|IssueLabelsLabel | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `colorInput`Optional + +```java +public java.lang.String getColorInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `descriptionInput`Optional + +```java +public java.lang.String getDescriptionInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `color`Required + +```java +public java.lang.String getColor(); +``` + +- *Type:* java.lang.String + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|IssueLabelsLabel getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|IssueLabelsLabel + +--- + + + diff --git a/docs/membership.csharp.md b/docs/membership.csharp.md new file mode 100644 index 000000000..9b338b081 --- /dev/null +++ b/docs/membership.csharp.md @@ -0,0 +1,977 @@ +# `membership` Submodule + +## Constructs + +### Membership + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/membership github_membership}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new Membership(Construct Scope, string Id, MembershipConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | MembershipConfig | *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:* MembershipConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetDowngradeOnDestroy | *No description.* | +| ResetId | *No description.* | +| ResetRole | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetDowngradeOnDestroy` + +```csharp +private void ResetDowngradeOnDestroy() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetRole` + +```csharp +private void ResetRole() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a Membership resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +Membership.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` + +```csharp +using Io.Cdktn.Providers.Github; + +Membership.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +Membership.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +Membership.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a Membership resource upon running "cdktn 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 Membership to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing Membership that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/membership#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the Membership to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Etag | string | *No description.* | +| DowngradeOnDestroyInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| IdInput | string | *No description.* | +| RoleInput | string | *No description.* | +| UsernameInput | string | *No description.* | +| DowngradeOnDestroy | bool\|Io.Cdktn.IResolvable | *No description.* | +| Id | string | *No description.* | +| Role | string | *No description.* | +| Username | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `DowngradeOnDestroyInput`Optional + +```csharp +public bool|IResolvable DowngradeOnDestroyInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RoleInput`Optional + +```csharp +public string RoleInput { get; } +``` + +- *Type:* string + +--- + +##### `UsernameInput`Optional + +```csharp +public string UsernameInput { get; } +``` + +- *Type:* string + +--- + +##### `DowngradeOnDestroy`Required + +```csharp +public bool|IResolvable DowngradeOnDestroy { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Role`Required + +```csharp +public string Role { get; } +``` + +- *Type:* string + +--- + +##### `Username`Required + +```csharp +public string Username { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### MembershipConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new MembershipConfig { + 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 Username, + bool|IResolvable DowngradeOnDestroy = null, + string Id = null, + string Role = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Username | string | The user to add to the organization. | +| DowngradeOnDestroy | bool\|Io.Cdktn.IResolvable | Instead of removing the member from the org, you can choose to downgrade their membership to 'member' when this resource is destroyed. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/membership#id Membership#id}. | +| Role | string | The role of the user within the organization. Must be one of 'member' or 'admin'. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Username`Required + +```csharp +public string Username { get; set; } +``` + +- *Type:* string + +The user to add to the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/membership#username Membership#username} + +--- + +##### `DowngradeOnDestroy`Optional + +```csharp +public bool|IResolvable DowngradeOnDestroy { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Instead of removing the member from the org, you can choose to downgrade their membership to 'member' when this resource is destroyed. + +This is useful when wanting to downgrade admins while keeping them in the organization + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/membership#downgrade_on_destroy Membership#downgrade_on_destroy} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/membership#id Membership#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. + +--- + +##### `Role`Optional + +```csharp +public string Role { get; set; } +``` + +- *Type:* string + +The role of the user within the organization. Must be one of 'member' or 'admin'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/membership#role Membership#role} + +--- + + + diff --git a/docs/membership.java.md b/docs/membership.java.md new file mode 100644 index 000000000..f5e6b55a2 --- /dev/null +++ b/docs/membership.java.md @@ -0,0 +1,1080 @@ +# `membership` Submodule + +## Constructs + +### Membership + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/membership github_membership}. + +#### Initializers + +```java +import io.cdktn.providers.github.membership.Membership; + +Membership.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .username(java.lang.String) +// .downgradeOnDestroy(java.lang.Boolean|IResolvable) +// .id(java.lang.String) +// .role(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 | *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 | *No description.* | +| username | java.lang.String | The user to add to the organization. | +| downgradeOnDestroy | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Instead of removing the member from the org, you can choose to downgrade their membership to 'member' when this resource is destroyed. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/membership#id Membership#id}. | +| role | java.lang.String | The role of the user within the organization. Must be one of 'member' or 'admin'. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `username`Required + +- *Type:* java.lang.String + +The user to add to the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/membership#username Membership#username} + +--- + +##### `downgradeOnDestroy`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Instead of removing the member from the org, you can choose to downgrade their membership to 'member' when this resource is destroyed. + +This is useful when wanting to downgrade admins while keeping them in the organization + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/membership#downgrade_on_destroy Membership#downgrade_on_destroy} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/membership#id Membership#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. + +--- + +##### `role`Optional + +- *Type:* java.lang.String + +The role of the user within the organization. Must be one of 'member' or 'admin'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/membership#role Membership#role} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetDowngradeOnDestroy | *No description.* | +| resetId | *No description.* | +| resetRole | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetDowngradeOnDestroy` + +```java +public void resetDowngradeOnDestroy() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetRole` + +```java +public void resetRole() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a Membership resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.membership.Membership; + +Membership.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` + +```java +import io.cdktn.providers.github.membership.Membership; + +Membership.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.membership.Membership; + +Membership.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.membership.Membership; + +Membership.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),Membership.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a Membership 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 Membership to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing Membership that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/membership#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 Membership 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| etag | java.lang.String | *No description.* | +| downgradeOnDestroyInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| idInput | java.lang.String | *No description.* | +| roleInput | java.lang.String | *No description.* | +| usernameInput | java.lang.String | *No description.* | +| downgradeOnDestroy | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| id | java.lang.String | *No description.* | +| role | java.lang.String | *No description.* | +| username | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `downgradeOnDestroyInput`Optional + +```java +public java.lang.Boolean|IResolvable getDowngradeOnDestroyInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `roleInput`Optional + +```java +public java.lang.String getRoleInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `usernameInput`Optional + +```java +public java.lang.String getUsernameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `downgradeOnDestroy`Required + +```java +public java.lang.Boolean|IResolvable getDowngradeOnDestroy(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `role`Required + +```java +public java.lang.String getRole(); +``` + +- *Type:* java.lang.String + +--- + +##### `username`Required + +```java +public java.lang.String getUsername(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### MembershipConfig + +#### Initializer + +```java +import io.cdktn.providers.github.membership.MembershipConfig; + +MembershipConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .username(java.lang.String) +// .downgradeOnDestroy(java.lang.Boolean|IResolvable) +// .id(java.lang.String) +// .role(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 | *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 | *No description.* | +| username | java.lang.String | The user to add to the organization. | +| downgradeOnDestroy | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Instead of removing the member from the org, you can choose to downgrade their membership to 'member' when this resource is destroyed. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/membership#id Membership#id}. | +| role | java.lang.String | The role of the user within the organization. Must be one of 'member' or 'admin'. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `username`Required + +```java +public java.lang.String getUsername(); +``` + +- *Type:* java.lang.String + +The user to add to the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/membership#username Membership#username} + +--- + +##### `downgradeOnDestroy`Optional + +```java +public java.lang.Boolean|IResolvable getDowngradeOnDestroy(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Instead of removing the member from the org, you can choose to downgrade their membership to 'member' when this resource is destroyed. + +This is useful when wanting to downgrade admins while keeping them in the organization + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/membership#downgrade_on_destroy Membership#downgrade_on_destroy} + +--- + +##### `id`Optional + +```java +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/resources/membership#id Membership#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. + +--- + +##### `role`Optional + +```java +public java.lang.String getRole(); +``` + +- *Type:* java.lang.String + +The role of the user within the organization. Must be one of 'member' or 'admin'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/membership#role Membership#role} + +--- + + + diff --git a/docs/organizationBlock.csharp.md b/docs/organizationBlock.csharp.md new file mode 100644 index 000000000..b34ae239b --- /dev/null +++ b/docs/organizationBlock.csharp.md @@ -0,0 +1,885 @@ +# `organizationBlock` Submodule + +## Constructs + +### OrganizationBlock + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_block github_organization_block}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationBlock(Construct Scope, string Id, OrganizationBlockConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | OrganizationBlockConfig | *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:* OrganizationBlockConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a OrganizationBlock resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationBlock.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` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationBlock.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationBlock.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationBlock.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a OrganizationBlock resource upon running "cdktn 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 OrganizationBlock to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing OrganizationBlock that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_block#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the OrganizationBlock to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Etag | string | *No description.* | +| IdInput | string | *No description.* | +| UsernameInput | string | *No description.* | +| Id | string | *No description.* | +| Username | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `UsernameInput`Optional + +```csharp +public string UsernameInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Username`Required + +```csharp +public string Username { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### OrganizationBlockConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationBlockConfig { + 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 Username, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Username | string | The name of the user to block. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_block#id OrganizationBlock#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Username`Required + +```csharp +public string Username { get; set; } +``` + +- *Type:* string + +The name of the user to block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_block#username OrganizationBlock#username} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_block#id OrganizationBlock#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. + +--- + + + diff --git a/docs/organizationBlock.java.md b/docs/organizationBlock.java.md new file mode 100644 index 000000000..2e24442c6 --- /dev/null +++ b/docs/organizationBlock.java.md @@ -0,0 +1,962 @@ +# `organizationBlock` Submodule + +## Constructs + +### OrganizationBlock + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_block github_organization_block}. + +#### Initializers + +```java +import io.cdktn.providers.github.organization_block.OrganizationBlock; + +OrganizationBlock.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .username(java.lang.String) +// .id(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 | *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 | *No description.* | +| username | java.lang.String | The name of the user to block. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_block#id OrganizationBlock#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `username`Required + +- *Type:* java.lang.String + +The name of the user to block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_block#username OrganizationBlock#username} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_block#id OrganizationBlock#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a OrganizationBlock resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.organization_block.OrganizationBlock; + +OrganizationBlock.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` + +```java +import io.cdktn.providers.github.organization_block.OrganizationBlock; + +OrganizationBlock.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.organization_block.OrganizationBlock; + +OrganizationBlock.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.organization_block.OrganizationBlock; + +OrganizationBlock.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),OrganizationBlock.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a OrganizationBlock 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 OrganizationBlock to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing OrganizationBlock that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_block#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 OrganizationBlock 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| etag | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| usernameInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| username | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `usernameInput`Optional + +```java +public java.lang.String getUsernameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `username`Required + +```java +public java.lang.String getUsername(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### OrganizationBlockConfig + +#### Initializer + +```java +import io.cdktn.providers.github.organization_block.OrganizationBlockConfig; + +OrganizationBlockConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .username(java.lang.String) +// .id(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 | *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 | *No description.* | +| username | java.lang.String | The name of the user to block. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_block#id OrganizationBlock#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `username`Required + +```java +public java.lang.String getUsername(); +``` + +- *Type:* java.lang.String + +The name of the user to block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_block#username OrganizationBlock#username} + +--- + +##### `id`Optional + +```java +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/resources/organization_block#id OrganizationBlock#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. + +--- + + + diff --git a/docs/organizationCustomProperties.csharp.md b/docs/organizationCustomProperties.csharp.md new file mode 100644 index 000000000..cbda694c3 --- /dev/null +++ b/docs/organizationCustomProperties.csharp.md @@ -0,0 +1,1146 @@ +# `organizationCustomProperties` Submodule + +## Constructs + +### OrganizationCustomProperties + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties github_organization_custom_properties}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationCustomProperties(Construct Scope, string Id, OrganizationCustomPropertiesConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | OrganizationCustomPropertiesConfig | *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:* OrganizationCustomPropertiesConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetAllowedValues | *No description.* | +| ResetDefaultValue | *No description.* | +| ResetDescription | *No description.* | +| ResetId | *No description.* | +| ResetRequired | *No description.* | +| ResetValuesEditableBy | *No description.* | +| ResetValueType | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetAllowedValues` + +```csharp +private void ResetAllowedValues() +``` + +##### `ResetDefaultValue` + +```csharp +private void ResetDefaultValue() +``` + +##### `ResetDescription` + +```csharp +private void ResetDescription() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetRequired` + +```csharp +private void ResetRequired() +``` + +##### `ResetValuesEditableBy` + +```csharp +private void ResetValuesEditableBy() +``` + +##### `ResetValueType` + +```csharp +private void ResetValueType() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a OrganizationCustomProperties resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationCustomProperties.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` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationCustomProperties.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationCustomProperties.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationCustomProperties.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a OrganizationCustomProperties resource upon running "cdktn 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 OrganizationCustomProperties to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing OrganizationCustomProperties that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the OrganizationCustomProperties to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| AllowedValuesInput | string[] | *No description.* | +| DefaultValueInput | string | *No description.* | +| DescriptionInput | string | *No description.* | +| IdInput | string | *No description.* | +| PropertyNameInput | string | *No description.* | +| RequiredInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| ValuesEditableByInput | string | *No description.* | +| ValueTypeInput | string | *No description.* | +| AllowedValues | string[] | *No description.* | +| DefaultValue | string | *No description.* | +| Description | string | *No description.* | +| Id | string | *No description.* | +| PropertyName | string | *No description.* | +| Required | bool\|Io.Cdktn.IResolvable | *No description.* | +| ValuesEditableBy | string | *No description.* | +| ValueType | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `AllowedValuesInput`Optional + +```csharp +public string[] AllowedValuesInput { get; } +``` + +- *Type:* string[] + +--- + +##### `DefaultValueInput`Optional + +```csharp +public string DefaultValueInput { get; } +``` + +- *Type:* string + +--- + +##### `DescriptionInput`Optional + +```csharp +public string DescriptionInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `PropertyNameInput`Optional + +```csharp +public string PropertyNameInput { get; } +``` + +- *Type:* string + +--- + +##### `RequiredInput`Optional + +```csharp +public bool|IResolvable RequiredInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ValuesEditableByInput`Optional + +```csharp +public string ValuesEditableByInput { get; } +``` + +- *Type:* string + +--- + +##### `ValueTypeInput`Optional + +```csharp +public string ValueTypeInput { get; } +``` + +- *Type:* string + +--- + +##### `AllowedValues`Required + +```csharp +public string[] AllowedValues { get; } +``` + +- *Type:* string[] + +--- + +##### `DefaultValue`Required + +```csharp +public string DefaultValue { get; } +``` + +- *Type:* string + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `PropertyName`Required + +```csharp +public string PropertyName { get; } +``` + +- *Type:* string + +--- + +##### `Required`Required + +```csharp +public bool|IResolvable Required { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ValuesEditableBy`Required + +```csharp +public string ValuesEditableBy { get; } +``` + +- *Type:* string + +--- + +##### `ValueType`Required + +```csharp +public string ValueType { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### OrganizationCustomPropertiesConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationCustomPropertiesConfig { + 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 PropertyName, + string[] AllowedValues = null, + string DefaultValue = null, + string Description = null, + string Id = null, + bool|IResolvable Required = null, + string ValuesEditableBy = null, + string ValueType = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| PropertyName | string | The name of the custom property. | +| AllowedValues | string[] | The allowed values of the custom property. | +| DefaultValue | string | The default value of the custom property. | +| Description | string | The description of the custom property. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#id OrganizationCustomProperties#id}. | +| Required | bool\|Io.Cdktn.IResolvable | Whether the custom property is required. | +| ValuesEditableBy | string | Who can edit the values of the custom property. | +| ValueType | string | The type of the custom property. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `PropertyName`Required + +```csharp +public string PropertyName { get; set; } +``` + +- *Type:* string + +The name of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#property_name OrganizationCustomProperties#property_name} + +--- + +##### `AllowedValues`Optional + +```csharp +public string[] AllowedValues { get; set; } +``` + +- *Type:* string[] + +The allowed values of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#allowed_values OrganizationCustomProperties#allowed_values} + +--- + +##### `DefaultValue`Optional + +```csharp +public string DefaultValue { get; set; } +``` + +- *Type:* string + +The default value of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#default_value OrganizationCustomProperties#default_value} + +--- + +##### `Description`Optional + +```csharp +public string Description { get; set; } +``` + +- *Type:* string + +The description of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#description OrganizationCustomProperties#description} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#id OrganizationCustomProperties#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. + +--- + +##### `Required`Optional + +```csharp +public bool|IResolvable Required { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether the custom property is required. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#required OrganizationCustomProperties#required} + +--- + +##### `ValuesEditableBy`Optional + +```csharp +public string ValuesEditableBy { get; set; } +``` + +- *Type:* string + +Who can edit the values of the custom property. + +Can be one of 'org_actors' or 'org_and_repo_actors'. If not specified, the default is 'org_actors' (only organization owners can edit values) + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#values_editable_by OrganizationCustomProperties#values_editable_by} + +--- + +##### `ValueType`Optional + +```csharp +public string ValueType { get; set; } +``` + +- *Type:* string + +The type of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#value_type OrganizationCustomProperties#value_type} + +--- + + + diff --git a/docs/organizationCustomProperties.java.md b/docs/organizationCustomProperties.java.md new file mode 100644 index 000000000..67f7c7676 --- /dev/null +++ b/docs/organizationCustomProperties.java.md @@ -0,0 +1,1297 @@ +# `organizationCustomProperties` Submodule + +## Constructs + +### OrganizationCustomProperties + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties github_organization_custom_properties}. + +#### Initializers + +```java +import io.cdktn.providers.github.organization_custom_properties.OrganizationCustomProperties; + +OrganizationCustomProperties.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .propertyName(java.lang.String) +// .allowedValues(java.util.List) +// .defaultValue(java.lang.String) +// .description(java.lang.String) +// .id(java.lang.String) +// .required(java.lang.Boolean|IResolvable) +// .valuesEditableBy(java.lang.String) +// .valueType(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 | *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 | *No description.* | +| propertyName | java.lang.String | The name of the custom property. | +| allowedValues | java.util.List | The allowed values of the custom property. | +| defaultValue | java.lang.String | The default value of the custom property. | +| description | java.lang.String | The description of the custom property. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#id OrganizationCustomProperties#id}. | +| required | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether the custom property is required. | +| valuesEditableBy | java.lang.String | Who can edit the values of the custom property. | +| valueType | java.lang.String | The type of the custom property. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `propertyName`Required + +- *Type:* java.lang.String + +The name of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#property_name OrganizationCustomProperties#property_name} + +--- + +##### `allowedValues`Optional + +- *Type:* java.util.List + +The allowed values of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#allowed_values OrganizationCustomProperties#allowed_values} + +--- + +##### `defaultValue`Optional + +- *Type:* java.lang.String + +The default value of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#default_value OrganizationCustomProperties#default_value} + +--- + +##### `description`Optional + +- *Type:* java.lang.String + +The description of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#description OrganizationCustomProperties#description} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#id OrganizationCustomProperties#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. + +--- + +##### `required`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether the custom property is required. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#required OrganizationCustomProperties#required} + +--- + +##### `valuesEditableBy`Optional + +- *Type:* java.lang.String + +Who can edit the values of the custom property. + +Can be one of 'org_actors' or 'org_and_repo_actors'. If not specified, the default is 'org_actors' (only organization owners can edit values) + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#values_editable_by OrganizationCustomProperties#values_editable_by} + +--- + +##### `valueType`Optional + +- *Type:* java.lang.String + +The type of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#value_type OrganizationCustomProperties#value_type} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetAllowedValues | *No description.* | +| resetDefaultValue | *No description.* | +| resetDescription | *No description.* | +| resetId | *No description.* | +| resetRequired | *No description.* | +| resetValuesEditableBy | *No description.* | +| resetValueType | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetAllowedValues` + +```java +public void resetAllowedValues() +``` + +##### `resetDefaultValue` + +```java +public void resetDefaultValue() +``` + +##### `resetDescription` + +```java +public void resetDescription() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetRequired` + +```java +public void resetRequired() +``` + +##### `resetValuesEditableBy` + +```java +public void resetValuesEditableBy() +``` + +##### `resetValueType` + +```java +public void resetValueType() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a OrganizationCustomProperties resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.organization_custom_properties.OrganizationCustomProperties; + +OrganizationCustomProperties.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` + +```java +import io.cdktn.providers.github.organization_custom_properties.OrganizationCustomProperties; + +OrganizationCustomProperties.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.organization_custom_properties.OrganizationCustomProperties; + +OrganizationCustomProperties.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.organization_custom_properties.OrganizationCustomProperties; + +OrganizationCustomProperties.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),OrganizationCustomProperties.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a OrganizationCustomProperties 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 OrganizationCustomProperties to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing OrganizationCustomProperties that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#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 OrganizationCustomProperties 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| allowedValuesInput | java.util.List | *No description.* | +| defaultValueInput | java.lang.String | *No description.* | +| descriptionInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| propertyNameInput | java.lang.String | *No description.* | +| requiredInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| valuesEditableByInput | java.lang.String | *No description.* | +| valueTypeInput | java.lang.String | *No description.* | +| allowedValues | java.util.List | *No description.* | +| defaultValue | java.lang.String | *No description.* | +| description | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| propertyName | java.lang.String | *No description.* | +| required | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| valuesEditableBy | java.lang.String | *No description.* | +| valueType | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `allowedValuesInput`Optional + +```java +public java.util.List getAllowedValuesInput(); +``` + +- *Type:* java.util.List + +--- + +##### `defaultValueInput`Optional + +```java +public java.lang.String getDefaultValueInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `descriptionInput`Optional + +```java +public java.lang.String getDescriptionInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `propertyNameInput`Optional + +```java +public java.lang.String getPropertyNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `requiredInput`Optional + +```java +public java.lang.Boolean|IResolvable getRequiredInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `valuesEditableByInput`Optional + +```java +public java.lang.String getValuesEditableByInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `valueTypeInput`Optional + +```java +public java.lang.String getValueTypeInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `allowedValues`Required + +```java +public java.util.List getAllowedValues(); +``` + +- *Type:* java.util.List + +--- + +##### `defaultValue`Required + +```java +public java.lang.String getDefaultValue(); +``` + +- *Type:* java.lang.String + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `propertyName`Required + +```java +public java.lang.String getPropertyName(); +``` + +- *Type:* java.lang.String + +--- + +##### `required`Required + +```java +public java.lang.Boolean|IResolvable getRequired(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `valuesEditableBy`Required + +```java +public java.lang.String getValuesEditableBy(); +``` + +- *Type:* java.lang.String + +--- + +##### `valueType`Required + +```java +public java.lang.String getValueType(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### OrganizationCustomPropertiesConfig + +#### Initializer + +```java +import io.cdktn.providers.github.organization_custom_properties.OrganizationCustomPropertiesConfig; + +OrganizationCustomPropertiesConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .propertyName(java.lang.String) +// .allowedValues(java.util.List) +// .defaultValue(java.lang.String) +// .description(java.lang.String) +// .id(java.lang.String) +// .required(java.lang.Boolean|IResolvable) +// .valuesEditableBy(java.lang.String) +// .valueType(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 | *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 | *No description.* | +| propertyName | java.lang.String | The name of the custom property. | +| allowedValues | java.util.List | The allowed values of the custom property. | +| defaultValue | java.lang.String | The default value of the custom property. | +| description | java.lang.String | The description of the custom property. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#id OrganizationCustomProperties#id}. | +| required | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether the custom property is required. | +| valuesEditableBy | java.lang.String | Who can edit the values of the custom property. | +| valueType | java.lang.String | The type of the custom property. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `propertyName`Required + +```java +public java.lang.String getPropertyName(); +``` + +- *Type:* java.lang.String + +The name of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#property_name OrganizationCustomProperties#property_name} + +--- + +##### `allowedValues`Optional + +```java +public java.util.List getAllowedValues(); +``` + +- *Type:* java.util.List + +The allowed values of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#allowed_values OrganizationCustomProperties#allowed_values} + +--- + +##### `defaultValue`Optional + +```java +public java.lang.String getDefaultValue(); +``` + +- *Type:* java.lang.String + +The default value of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#default_value OrganizationCustomProperties#default_value} + +--- + +##### `description`Optional + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +The description of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#description OrganizationCustomProperties#description} + +--- + +##### `id`Optional + +```java +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/resources/organization_custom_properties#id OrganizationCustomProperties#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. + +--- + +##### `required`Optional + +```java +public java.lang.Boolean|IResolvable getRequired(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether the custom property is required. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#required OrganizationCustomProperties#required} + +--- + +##### `valuesEditableBy`Optional + +```java +public java.lang.String getValuesEditableBy(); +``` + +- *Type:* java.lang.String + +Who can edit the values of the custom property. + +Can be one of 'org_actors' or 'org_and_repo_actors'. If not specified, the default is 'org_actors' (only organization owners can edit values) + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#values_editable_by OrganizationCustomProperties#values_editable_by} + +--- + +##### `valueType`Optional + +```java +public java.lang.String getValueType(); +``` + +- *Type:* java.lang.String + +The type of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_properties#value_type OrganizationCustomProperties#value_type} + +--- + + + diff --git a/docs/organizationCustomRole.csharp.md b/docs/organizationCustomRole.csharp.md new file mode 100644 index 000000000..126e61ffe --- /dev/null +++ b/docs/organizationCustomRole.csharp.md @@ -0,0 +1,995 @@ +# `organizationCustomRole` Submodule + +## Constructs + +### OrganizationCustomRole + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_role github_organization_custom_role}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationCustomRole(Construct Scope, string Id, OrganizationCustomRoleConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | OrganizationCustomRoleConfig | *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:* OrganizationCustomRoleConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetDescription | *No description.* | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetDescription` + +```csharp +private void ResetDescription() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a OrganizationCustomRole resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationCustomRole.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` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationCustomRole.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationCustomRole.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationCustomRole.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a OrganizationCustomRole resource upon running "cdktn 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 OrganizationCustomRole to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing OrganizationCustomRole that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_role#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the OrganizationCustomRole to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| BaseRoleInput | string | *No description.* | +| DescriptionInput | string | *No description.* | +| IdInput | string | *No description.* | +| NameInput | string | *No description.* | +| PermissionsInput | string[] | *No description.* | +| BaseRole | string | *No description.* | +| Description | string | *No description.* | +| Id | string | *No description.* | +| Name | string | *No description.* | +| Permissions | string[] | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `BaseRoleInput`Optional + +```csharp +public string BaseRoleInput { get; } +``` + +- *Type:* string + +--- + +##### `DescriptionInput`Optional + +```csharp +public string DescriptionInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `PermissionsInput`Optional + +```csharp +public string[] PermissionsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `BaseRole`Required + +```csharp +public string BaseRole { get; } +``` + +- *Type:* string + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Permissions`Required + +```csharp +public string[] Permissions { get; } +``` + +- *Type:* string[] + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### OrganizationCustomRoleConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationCustomRoleConfig { + 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 BaseRole, + string Name, + string[] Permissions, + string Description = null, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| BaseRole | string | The base role for the custom repository role. | +| Name | string | The organization custom repository role to create. | +| Permissions | string[] | The permissions for the custom repository role. | +| Description | string | The description of the custom repository role. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_role#id OrganizationCustomRole#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `BaseRole`Required + +```csharp +public string BaseRole { get; set; } +``` + +- *Type:* string + +The base role for the custom repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_role#base_role OrganizationCustomRole#base_role} + +--- + +##### `Name`Required + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +The organization custom repository role to create. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_role#name OrganizationCustomRole#name} + +--- + +##### `Permissions`Required + +```csharp +public string[] Permissions { get; set; } +``` + +- *Type:* string[] + +The permissions for the custom repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_role#permissions OrganizationCustomRole#permissions} + +--- + +##### `Description`Optional + +```csharp +public string Description { get; set; } +``` + +- *Type:* string + +The description of the custom repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_role#description OrganizationCustomRole#description} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_role#id OrganizationCustomRole#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. + +--- + + + diff --git a/docs/organizationCustomRole.java.md b/docs/organizationCustomRole.java.md new file mode 100644 index 000000000..6920f4152 --- /dev/null +++ b/docs/organizationCustomRole.java.md @@ -0,0 +1,1108 @@ +# `organizationCustomRole` Submodule + +## Constructs + +### OrganizationCustomRole + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_role github_organization_custom_role}. + +#### Initializers + +```java +import io.cdktn.providers.github.organization_custom_role.OrganizationCustomRole; + +OrganizationCustomRole.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .baseRole(java.lang.String) + .name(java.lang.String) + .permissions(java.util.List) +// .description(java.lang.String) +// .id(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 | *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 | *No description.* | +| baseRole | java.lang.String | The base role for the custom repository role. | +| name | java.lang.String | The organization custom repository role to create. | +| permissions | java.util.List | The permissions for the custom repository role. | +| description | java.lang.String | The description of the custom repository role. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_role#id OrganizationCustomRole#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `baseRole`Required + +- *Type:* java.lang.String + +The base role for the custom repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_role#base_role OrganizationCustomRole#base_role} + +--- + +##### `name`Required + +- *Type:* java.lang.String + +The organization custom repository role to create. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_role#name OrganizationCustomRole#name} + +--- + +##### `permissions`Required + +- *Type:* java.util.List + +The permissions for the custom repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_role#permissions OrganizationCustomRole#permissions} + +--- + +##### `description`Optional + +- *Type:* java.lang.String + +The description of the custom repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_role#description OrganizationCustomRole#description} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_role#id OrganizationCustomRole#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetDescription | *No description.* | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetDescription` + +```java +public void resetDescription() +``` + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a OrganizationCustomRole resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.organization_custom_role.OrganizationCustomRole; + +OrganizationCustomRole.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` + +```java +import io.cdktn.providers.github.organization_custom_role.OrganizationCustomRole; + +OrganizationCustomRole.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.organization_custom_role.OrganizationCustomRole; + +OrganizationCustomRole.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.organization_custom_role.OrganizationCustomRole; + +OrganizationCustomRole.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),OrganizationCustomRole.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a OrganizationCustomRole 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 OrganizationCustomRole to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing OrganizationCustomRole that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_role#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 OrganizationCustomRole 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| baseRoleInput | java.lang.String | *No description.* | +| descriptionInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| permissionsInput | java.util.List | *No description.* | +| baseRole | java.lang.String | *No description.* | +| description | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| permissions | java.util.List | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `baseRoleInput`Optional + +```java +public java.lang.String getBaseRoleInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `descriptionInput`Optional + +```java +public java.lang.String getDescriptionInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `permissionsInput`Optional + +```java +public java.util.List getPermissionsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `baseRole`Required + +```java +public java.lang.String getBaseRole(); +``` + +- *Type:* java.lang.String + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `permissions`Required + +```java +public java.util.List getPermissions(); +``` + +- *Type:* java.util.List + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### OrganizationCustomRoleConfig + +#### Initializer + +```java +import io.cdktn.providers.github.organization_custom_role.OrganizationCustomRoleConfig; + +OrganizationCustomRoleConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .baseRole(java.lang.String) + .name(java.lang.String) + .permissions(java.util.List) +// .description(java.lang.String) +// .id(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 | *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 | *No description.* | +| baseRole | java.lang.String | The base role for the custom repository role. | +| name | java.lang.String | The organization custom repository role to create. | +| permissions | java.util.List | The permissions for the custom repository role. | +| description | java.lang.String | The description of the custom repository role. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_role#id OrganizationCustomRole#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `baseRole`Required + +```java +public java.lang.String getBaseRole(); +``` + +- *Type:* java.lang.String + +The base role for the custom repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_role#base_role OrganizationCustomRole#base_role} + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +The organization custom repository role to create. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_role#name OrganizationCustomRole#name} + +--- + +##### `permissions`Required + +```java +public java.util.List getPermissions(); +``` + +- *Type:* java.util.List + +The permissions for the custom repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_role#permissions OrganizationCustomRole#permissions} + +--- + +##### `description`Optional + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +The description of the custom repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_custom_role#description OrganizationCustomRole#description} + +--- + +##### `id`Optional + +```java +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/resources/organization_custom_role#id OrganizationCustomRole#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. + +--- + + + diff --git a/docs/organizationProject.csharp.md b/docs/organizationProject.csharp.md new file mode 100644 index 000000000..3865a95ab --- /dev/null +++ b/docs/organizationProject.csharp.md @@ -0,0 +1,941 @@ +# `organizationProject` Submodule + +## Constructs + +### OrganizationProject + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_project github_organization_project}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationProject(Construct Scope, string Id, OrganizationProjectConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | OrganizationProjectConfig | *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:* OrganizationProjectConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetBody | *No description.* | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetBody` + +```csharp +private void ResetBody() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a OrganizationProject resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationProject.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` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationProject.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationProject.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationProject.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a OrganizationProject resource upon running "cdktn 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 OrganizationProject to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing OrganizationProject that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_project#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the OrganizationProject to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Etag | string | *No description.* | +| Url | string | *No description.* | +| BodyInput | string | *No description.* | +| IdInput | string | *No description.* | +| NameInput | string | *No description.* | +| Body | string | *No description.* | +| Id | string | *No description.* | +| Name | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `Url`Required + +```csharp +public string Url { get; } +``` + +- *Type:* string + +--- + +##### `BodyInput`Optional + +```csharp +public string BodyInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `Body`Required + +```csharp +public string Body { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### OrganizationProjectConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationProjectConfig { + 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 Name, + string Body = null, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Name | string | The name of the project. | +| Body | string | The body of the project. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_project#id OrganizationProject#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Name`Required + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +The name of the project. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_project#name OrganizationProject#name} + +--- + +##### `Body`Optional + +```csharp +public string Body { get; set; } +``` + +- *Type:* string + +The body of the project. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_project#body OrganizationProject#body} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_project#id OrganizationProject#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. + +--- + + + diff --git a/docs/organizationProject.java.md b/docs/organizationProject.java.md new file mode 100644 index 000000000..1b4f47b62 --- /dev/null +++ b/docs/organizationProject.java.md @@ -0,0 +1,1030 @@ +# `organizationProject` Submodule + +## Constructs + +### OrganizationProject + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_project github_organization_project}. + +#### Initializers + +```java +import io.cdktn.providers.github.organization_project.OrganizationProject; + +OrganizationProject.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .name(java.lang.String) +// .body(java.lang.String) +// .id(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 | *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 | *No description.* | +| name | java.lang.String | The name of the project. | +| body | java.lang.String | The body of the project. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_project#id OrganizationProject#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `name`Required + +- *Type:* java.lang.String + +The name of the project. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_project#name OrganizationProject#name} + +--- + +##### `body`Optional + +- *Type:* java.lang.String + +The body of the project. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_project#body OrganizationProject#body} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_project#id OrganizationProject#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetBody | *No description.* | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetBody` + +```java +public void resetBody() +``` + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a OrganizationProject resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.organization_project.OrganizationProject; + +OrganizationProject.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` + +```java +import io.cdktn.providers.github.organization_project.OrganizationProject; + +OrganizationProject.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.organization_project.OrganizationProject; + +OrganizationProject.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.organization_project.OrganizationProject; + +OrganizationProject.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),OrganizationProject.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a OrganizationProject 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 OrganizationProject to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing OrganizationProject that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_project#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 OrganizationProject 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| etag | java.lang.String | *No description.* | +| url | java.lang.String | *No description.* | +| bodyInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| body | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `bodyInput`Optional + +```java +public java.lang.String getBodyInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `body`Required + +```java +public java.lang.String getBody(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### OrganizationProjectConfig + +#### Initializer + +```java +import io.cdktn.providers.github.organization_project.OrganizationProjectConfig; + +OrganizationProjectConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .name(java.lang.String) +// .body(java.lang.String) +// .id(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 | *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 | *No description.* | +| name | java.lang.String | The name of the project. | +| body | java.lang.String | The body of the project. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_project#id OrganizationProject#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +The name of the project. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_project#name OrganizationProject#name} + +--- + +##### `body`Optional + +```java +public java.lang.String getBody(); +``` + +- *Type:* java.lang.String + +The body of the project. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_project#body OrganizationProject#body} + +--- + +##### `id`Optional + +```java +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/resources/organization_project#id OrganizationProject#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. + +--- + + + diff --git a/docs/organizationRepositoryRole.csharp.md b/docs/organizationRepositoryRole.csharp.md new file mode 100644 index 000000000..0b6c5e058 --- /dev/null +++ b/docs/organizationRepositoryRole.csharp.md @@ -0,0 +1,1006 @@ +# `organizationRepositoryRole` Submodule + +## Constructs + +### OrganizationRepositoryRole + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_repository_role github_organization_repository_role}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRepositoryRole(Construct Scope, string Id, OrganizationRepositoryRoleConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | OrganizationRepositoryRoleConfig | *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:* OrganizationRepositoryRoleConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetDescription | *No description.* | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetDescription` + +```csharp +private void ResetDescription() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a OrganizationRepositoryRole resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRepositoryRole.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` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRepositoryRole.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRepositoryRole.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRepositoryRole.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a OrganizationRepositoryRole resource upon running "cdktn 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 OrganizationRepositoryRole to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing OrganizationRepositoryRole that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_repository_role#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the OrganizationRepositoryRole to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| RoleId | double | *No description.* | +| BaseRoleInput | string | *No description.* | +| DescriptionInput | string | *No description.* | +| IdInput | string | *No description.* | +| NameInput | string | *No description.* | +| PermissionsInput | string[] | *No description.* | +| BaseRole | string | *No description.* | +| Description | string | *No description.* | +| Id | string | *No description.* | +| Name | string | *No description.* | +| Permissions | string[] | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `RoleId`Required + +```csharp +public double RoleId { get; } +``` + +- *Type:* double + +--- + +##### `BaseRoleInput`Optional + +```csharp +public string BaseRoleInput { get; } +``` + +- *Type:* string + +--- + +##### `DescriptionInput`Optional + +```csharp +public string DescriptionInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `PermissionsInput`Optional + +```csharp +public string[] PermissionsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `BaseRole`Required + +```csharp +public string BaseRole { get; } +``` + +- *Type:* string + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Permissions`Required + +```csharp +public string[] Permissions { get; } +``` + +- *Type:* string[] + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### OrganizationRepositoryRoleConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRepositoryRoleConfig { + 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 BaseRole, + string Name, + string[] Permissions, + string Description = null, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| BaseRole | string | The base role for the organization repository role. | +| Name | string | The name of the organization repository role. | +| Permissions | string[] | The permissions for the organization repository role. | +| Description | string | The description of the organization repository role. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_repository_role#id OrganizationRepositoryRole#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `BaseRole`Required + +```csharp +public string BaseRole { get; set; } +``` + +- *Type:* string + +The base role for the organization repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_repository_role#base_role OrganizationRepositoryRole#base_role} + +--- + +##### `Name`Required + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +The name of the organization repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_repository_role#name OrganizationRepositoryRole#name} + +--- + +##### `Permissions`Required + +```csharp +public string[] Permissions { get; set; } +``` + +- *Type:* string[] + +The permissions for the organization repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_repository_role#permissions OrganizationRepositoryRole#permissions} + +--- + +##### `Description`Optional + +```csharp +public string Description { get; set; } +``` + +- *Type:* string + +The description of the organization repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_repository_role#description OrganizationRepositoryRole#description} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_repository_role#id OrganizationRepositoryRole#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. + +--- + + + diff --git a/docs/organizationRepositoryRole.java.md b/docs/organizationRepositoryRole.java.md new file mode 100644 index 000000000..dcbb7e9b1 --- /dev/null +++ b/docs/organizationRepositoryRole.java.md @@ -0,0 +1,1119 @@ +# `organizationRepositoryRole` Submodule + +## Constructs + +### OrganizationRepositoryRole + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_repository_role github_organization_repository_role}. + +#### Initializers + +```java +import io.cdktn.providers.github.organization_repository_role.OrganizationRepositoryRole; + +OrganizationRepositoryRole.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .baseRole(java.lang.String) + .name(java.lang.String) + .permissions(java.util.List) +// .description(java.lang.String) +// .id(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 | *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 | *No description.* | +| baseRole | java.lang.String | The base role for the organization repository role. | +| name | java.lang.String | The name of the organization repository role. | +| permissions | java.util.List | The permissions for the organization repository role. | +| description | java.lang.String | The description of the organization repository role. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_repository_role#id OrganizationRepositoryRole#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `baseRole`Required + +- *Type:* java.lang.String + +The base role for the organization repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_repository_role#base_role OrganizationRepositoryRole#base_role} + +--- + +##### `name`Required + +- *Type:* java.lang.String + +The name of the organization repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_repository_role#name OrganizationRepositoryRole#name} + +--- + +##### `permissions`Required + +- *Type:* java.util.List + +The permissions for the organization repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_repository_role#permissions OrganizationRepositoryRole#permissions} + +--- + +##### `description`Optional + +- *Type:* java.lang.String + +The description of the organization repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_repository_role#description OrganizationRepositoryRole#description} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_repository_role#id OrganizationRepositoryRole#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetDescription | *No description.* | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetDescription` + +```java +public void resetDescription() +``` + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a OrganizationRepositoryRole resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.organization_repository_role.OrganizationRepositoryRole; + +OrganizationRepositoryRole.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` + +```java +import io.cdktn.providers.github.organization_repository_role.OrganizationRepositoryRole; + +OrganizationRepositoryRole.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.organization_repository_role.OrganizationRepositoryRole; + +OrganizationRepositoryRole.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.organization_repository_role.OrganizationRepositoryRole; + +OrganizationRepositoryRole.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),OrganizationRepositoryRole.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a OrganizationRepositoryRole 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 OrganizationRepositoryRole to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing OrganizationRepositoryRole that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_repository_role#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 OrganizationRepositoryRole 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| roleId | java.lang.Number | *No description.* | +| baseRoleInput | java.lang.String | *No description.* | +| descriptionInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| permissionsInput | java.util.List | *No description.* | +| baseRole | java.lang.String | *No description.* | +| description | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| permissions | java.util.List | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `roleId`Required + +```java +public java.lang.Number getRoleId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `baseRoleInput`Optional + +```java +public java.lang.String getBaseRoleInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `descriptionInput`Optional + +```java +public java.lang.String getDescriptionInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `permissionsInput`Optional + +```java +public java.util.List getPermissionsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `baseRole`Required + +```java +public java.lang.String getBaseRole(); +``` + +- *Type:* java.lang.String + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `permissions`Required + +```java +public java.util.List getPermissions(); +``` + +- *Type:* java.util.List + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### OrganizationRepositoryRoleConfig + +#### Initializer + +```java +import io.cdktn.providers.github.organization_repository_role.OrganizationRepositoryRoleConfig; + +OrganizationRepositoryRoleConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .baseRole(java.lang.String) + .name(java.lang.String) + .permissions(java.util.List) +// .description(java.lang.String) +// .id(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 | *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 | *No description.* | +| baseRole | java.lang.String | The base role for the organization repository role. | +| name | java.lang.String | The name of the organization repository role. | +| permissions | java.util.List | The permissions for the organization repository role. | +| description | java.lang.String | The description of the organization repository role. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_repository_role#id OrganizationRepositoryRole#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `baseRole`Required + +```java +public java.lang.String getBaseRole(); +``` + +- *Type:* java.lang.String + +The base role for the organization repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_repository_role#base_role OrganizationRepositoryRole#base_role} + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +The name of the organization repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_repository_role#name OrganizationRepositoryRole#name} + +--- + +##### `permissions`Required + +```java +public java.util.List getPermissions(); +``` + +- *Type:* java.util.List + +The permissions for the organization repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_repository_role#permissions OrganizationRepositoryRole#permissions} + +--- + +##### `description`Optional + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +The description of the organization repository role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_repository_role#description OrganizationRepositoryRole#description} + +--- + +##### `id`Optional + +```java +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/resources/organization_repository_role#id OrganizationRepositoryRole#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. + +--- + + + diff --git a/docs/organizationRole.csharp.md b/docs/organizationRole.csharp.md new file mode 100644 index 000000000..9d3b03a67 --- /dev/null +++ b/docs/organizationRole.csharp.md @@ -0,0 +1,1013 @@ +# `organizationRole` Submodule + +## Constructs + +### OrganizationRole + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role github_organization_role}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRole(Construct Scope, string Id, OrganizationRoleConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | OrganizationRoleConfig | *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:* OrganizationRoleConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetBaseRole | *No description.* | +| ResetDescription | *No description.* | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetBaseRole` + +```csharp +private void ResetBaseRole() +``` + +##### `ResetDescription` + +```csharp +private void ResetDescription() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a OrganizationRole resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRole.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` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRole.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRole.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRole.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a OrganizationRole resource upon running "cdktn 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 OrganizationRole to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing OrganizationRole that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the OrganizationRole to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| RoleId | double | *No description.* | +| BaseRoleInput | string | *No description.* | +| DescriptionInput | string | *No description.* | +| IdInput | string | *No description.* | +| NameInput | string | *No description.* | +| PermissionsInput | string[] | *No description.* | +| BaseRole | string | *No description.* | +| Description | string | *No description.* | +| Id | string | *No description.* | +| Name | string | *No description.* | +| Permissions | string[] | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `RoleId`Required + +```csharp +public double RoleId { get; } +``` + +- *Type:* double + +--- + +##### `BaseRoleInput`Optional + +```csharp +public string BaseRoleInput { get; } +``` + +- *Type:* string + +--- + +##### `DescriptionInput`Optional + +```csharp +public string DescriptionInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `PermissionsInput`Optional + +```csharp +public string[] PermissionsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `BaseRole`Required + +```csharp +public string BaseRole { get; } +``` + +- *Type:* string + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Permissions`Required + +```csharp +public string[] Permissions { get; } +``` + +- *Type:* string[] + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### OrganizationRoleConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRoleConfig { + 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 Name, + string[] Permissions, + string BaseRole = null, + string Description = null, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Name | string | The name of the organization role. | +| Permissions | string[] | The permissions for the organization role. | +| BaseRole | string | The system role from which this role inherits permissions. | +| Description | string | The description of the organization role. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role#id OrganizationRole#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Name`Required + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +The name of the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role#name OrganizationRole#name} + +--- + +##### `Permissions`Required + +```csharp +public string[] Permissions { get; set; } +``` + +- *Type:* string[] + +The permissions for the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role#permissions OrganizationRole#permissions} + +--- + +##### `BaseRole`Optional + +```csharp +public string BaseRole { get; set; } +``` + +- *Type:* string + +The system role from which this role inherits permissions. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role#base_role OrganizationRole#base_role} + +--- + +##### `Description`Optional + +```csharp +public string Description { get; set; } +``` + +- *Type:* string + +The description of the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role#description OrganizationRole#description} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role#id OrganizationRole#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. + +--- + + + diff --git a/docs/organizationRole.java.md b/docs/organizationRole.java.md new file mode 100644 index 000000000..1964311b0 --- /dev/null +++ b/docs/organizationRole.java.md @@ -0,0 +1,1126 @@ +# `organizationRole` Submodule + +## Constructs + +### OrganizationRole + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role github_organization_role}. + +#### Initializers + +```java +import io.cdktn.providers.github.organization_role.OrganizationRole; + +OrganizationRole.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .name(java.lang.String) + .permissions(java.util.List) +// .baseRole(java.lang.String) +// .description(java.lang.String) +// .id(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 | *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 | *No description.* | +| name | java.lang.String | The name of the organization role. | +| permissions | java.util.List | The permissions for the organization role. | +| baseRole | java.lang.String | The system role from which this role inherits permissions. | +| description | java.lang.String | The description of the organization role. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role#id OrganizationRole#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `name`Required + +- *Type:* java.lang.String + +The name of the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role#name OrganizationRole#name} + +--- + +##### `permissions`Required + +- *Type:* java.util.List + +The permissions for the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role#permissions OrganizationRole#permissions} + +--- + +##### `baseRole`Optional + +- *Type:* java.lang.String + +The system role from which this role inherits permissions. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role#base_role OrganizationRole#base_role} + +--- + +##### `description`Optional + +- *Type:* java.lang.String + +The description of the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role#description OrganizationRole#description} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role#id OrganizationRole#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetBaseRole | *No description.* | +| resetDescription | *No description.* | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetBaseRole` + +```java +public void resetBaseRole() +``` + +##### `resetDescription` + +```java +public void resetDescription() +``` + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a OrganizationRole resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.organization_role.OrganizationRole; + +OrganizationRole.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` + +```java +import io.cdktn.providers.github.organization_role.OrganizationRole; + +OrganizationRole.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.organization_role.OrganizationRole; + +OrganizationRole.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.organization_role.OrganizationRole; + +OrganizationRole.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),OrganizationRole.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a OrganizationRole 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 OrganizationRole to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing OrganizationRole that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role#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 OrganizationRole 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| roleId | java.lang.Number | *No description.* | +| baseRoleInput | java.lang.String | *No description.* | +| descriptionInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| permissionsInput | java.util.List | *No description.* | +| baseRole | java.lang.String | *No description.* | +| description | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| permissions | java.util.List | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `roleId`Required + +```java +public java.lang.Number getRoleId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `baseRoleInput`Optional + +```java +public java.lang.String getBaseRoleInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `descriptionInput`Optional + +```java +public java.lang.String getDescriptionInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `permissionsInput`Optional + +```java +public java.util.List getPermissionsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `baseRole`Required + +```java +public java.lang.String getBaseRole(); +``` + +- *Type:* java.lang.String + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `permissions`Required + +```java +public java.util.List getPermissions(); +``` + +- *Type:* java.util.List + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### OrganizationRoleConfig + +#### Initializer + +```java +import io.cdktn.providers.github.organization_role.OrganizationRoleConfig; + +OrganizationRoleConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .name(java.lang.String) + .permissions(java.util.List) +// .baseRole(java.lang.String) +// .description(java.lang.String) +// .id(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 | *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 | *No description.* | +| name | java.lang.String | The name of the organization role. | +| permissions | java.util.List | The permissions for the organization role. | +| baseRole | java.lang.String | The system role from which this role inherits permissions. | +| description | java.lang.String | The description of the organization role. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role#id OrganizationRole#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +The name of the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role#name OrganizationRole#name} + +--- + +##### `permissions`Required + +```java +public java.util.List getPermissions(); +``` + +- *Type:* java.util.List + +The permissions for the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role#permissions OrganizationRole#permissions} + +--- + +##### `baseRole`Optional + +```java +public java.lang.String getBaseRole(); +``` + +- *Type:* java.lang.String + +The system role from which this role inherits permissions. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role#base_role OrganizationRole#base_role} + +--- + +##### `description`Optional + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +The description of the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role#description OrganizationRole#description} + +--- + +##### `id`Optional + +```java +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/resources/organization_role#id OrganizationRole#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. + +--- + + + diff --git a/docs/organizationRoleTeam.csharp.md b/docs/organizationRoleTeam.csharp.md new file mode 100644 index 000000000..f96c6be68 --- /dev/null +++ b/docs/organizationRoleTeam.csharp.md @@ -0,0 +1,912 @@ +# `organizationRoleTeam` Submodule + +## Constructs + +### OrganizationRoleTeam + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team github_organization_role_team}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRoleTeam(Construct Scope, string Id, OrganizationRoleTeamConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | OrganizationRoleTeamConfig | *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:* OrganizationRoleTeamConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a OrganizationRoleTeam resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRoleTeam.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` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRoleTeam.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRoleTeam.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRoleTeam.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a OrganizationRoleTeam resource upon running "cdktn 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 OrganizationRoleTeam to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing OrganizationRoleTeam that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the OrganizationRoleTeam to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| IdInput | string | *No description.* | +| RoleIdInput | double | *No description.* | +| TeamSlugInput | string | *No description.* | +| Id | string | *No description.* | +| RoleId | double | *No description.* | +| TeamSlug | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RoleIdInput`Optional + +```csharp +public double RoleIdInput { get; } +``` + +- *Type:* double + +--- + +##### `TeamSlugInput`Optional + +```csharp +public string TeamSlugInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `RoleId`Required + +```csharp +public double RoleId { get; } +``` + +- *Type:* double + +--- + +##### `TeamSlug`Required + +```csharp +public string TeamSlug { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### OrganizationRoleTeamConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRoleTeamConfig { + 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, + double RoleId, + string TeamSlug, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| RoleId | double | The ID of the organization role. | +| TeamSlug | string | The slug of the team name. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team#id OrganizationRoleTeam#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `RoleId`Required + +```csharp +public double RoleId { get; set; } +``` + +- *Type:* double + +The ID of the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team#role_id OrganizationRoleTeam#role_id} + +--- + +##### `TeamSlug`Required + +```csharp +public string TeamSlug { get; set; } +``` + +- *Type:* string + +The slug of the team name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team#team_slug OrganizationRoleTeam#team_slug} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team#id OrganizationRoleTeam#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. + +--- + + + diff --git a/docs/organizationRoleTeam.java.md b/docs/organizationRoleTeam.java.md new file mode 100644 index 000000000..5f53c0d96 --- /dev/null +++ b/docs/organizationRoleTeam.java.md @@ -0,0 +1,1001 @@ +# `organizationRoleTeam` Submodule + +## Constructs + +### OrganizationRoleTeam + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team github_organization_role_team}. + +#### Initializers + +```java +import io.cdktn.providers.github.organization_role_team.OrganizationRoleTeam; + +OrganizationRoleTeam.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .roleId(java.lang.Number) + .teamSlug(java.lang.String) +// .id(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 | *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 | *No description.* | +| roleId | java.lang.Number | The ID of the organization role. | +| teamSlug | java.lang.String | The slug of the team name. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team#id OrganizationRoleTeam#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `roleId`Required + +- *Type:* java.lang.Number + +The ID of the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team#role_id OrganizationRoleTeam#role_id} + +--- + +##### `teamSlug`Required + +- *Type:* java.lang.String + +The slug of the team name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team#team_slug OrganizationRoleTeam#team_slug} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team#id OrganizationRoleTeam#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a OrganizationRoleTeam resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.organization_role_team.OrganizationRoleTeam; + +OrganizationRoleTeam.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` + +```java +import io.cdktn.providers.github.organization_role_team.OrganizationRoleTeam; + +OrganizationRoleTeam.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.organization_role_team.OrganizationRoleTeam; + +OrganizationRoleTeam.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.organization_role_team.OrganizationRoleTeam; + +OrganizationRoleTeam.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),OrganizationRoleTeam.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a OrganizationRoleTeam 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 OrganizationRoleTeam to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing OrganizationRoleTeam that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team#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 OrganizationRoleTeam 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| idInput | java.lang.String | *No description.* | +| roleIdInput | java.lang.Number | *No description.* | +| teamSlugInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| roleId | java.lang.Number | *No description.* | +| teamSlug | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `roleIdInput`Optional + +```java +public java.lang.Number getRoleIdInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `teamSlugInput`Optional + +```java +public java.lang.String getTeamSlugInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `roleId`Required + +```java +public java.lang.Number getRoleId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `teamSlug`Required + +```java +public java.lang.String getTeamSlug(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### OrganizationRoleTeamConfig + +#### Initializer + +```java +import io.cdktn.providers.github.organization_role_team.OrganizationRoleTeamConfig; + +OrganizationRoleTeamConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .roleId(java.lang.Number) + .teamSlug(java.lang.String) +// .id(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 | *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 | *No description.* | +| roleId | java.lang.Number | The ID of the organization role. | +| teamSlug | java.lang.String | The slug of the team name. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team#id OrganizationRoleTeam#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `roleId`Required + +```java +public java.lang.Number getRoleId(); +``` + +- *Type:* java.lang.Number + +The ID of the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team#role_id OrganizationRoleTeam#role_id} + +--- + +##### `teamSlug`Required + +```java +public java.lang.String getTeamSlug(); +``` + +- *Type:* java.lang.String + +The slug of the team name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team#team_slug OrganizationRoleTeam#team_slug} + +--- + +##### `id`Optional + +```java +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/resources/organization_role_team#id OrganizationRoleTeam#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. + +--- + + + diff --git a/docs/organizationRoleTeamAssignment.csharp.md b/docs/organizationRoleTeamAssignment.csharp.md new file mode 100644 index 000000000..4b1f90dee --- /dev/null +++ b/docs/organizationRoleTeamAssignment.csharp.md @@ -0,0 +1,912 @@ +# `organizationRoleTeamAssignment` Submodule + +## Constructs + +### OrganizationRoleTeamAssignment + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team_assignment github_organization_role_team_assignment}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRoleTeamAssignment(Construct Scope, string Id, OrganizationRoleTeamAssignmentConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | OrganizationRoleTeamAssignmentConfig | *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:* OrganizationRoleTeamAssignmentConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a OrganizationRoleTeamAssignment resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRoleTeamAssignment.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` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRoleTeamAssignment.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRoleTeamAssignment.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRoleTeamAssignment.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a OrganizationRoleTeamAssignment resource upon running "cdktn 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 OrganizationRoleTeamAssignment to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing OrganizationRoleTeamAssignment that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team_assignment#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the OrganizationRoleTeamAssignment to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| IdInput | string | *No description.* | +| RoleIdInput | string | *No description.* | +| TeamSlugInput | string | *No description.* | +| Id | string | *No description.* | +| RoleId | string | *No description.* | +| TeamSlug | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RoleIdInput`Optional + +```csharp +public string RoleIdInput { get; } +``` + +- *Type:* string + +--- + +##### `TeamSlugInput`Optional + +```csharp +public string TeamSlugInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `RoleId`Required + +```csharp +public string RoleId { get; } +``` + +- *Type:* string + +--- + +##### `TeamSlug`Required + +```csharp +public string TeamSlug { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### OrganizationRoleTeamAssignmentConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRoleTeamAssignmentConfig { + 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 RoleId, + string TeamSlug, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| RoleId | string | The GitHub organization role id. | +| TeamSlug | string | The GitHub team slug. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team_assignment#id OrganizationRoleTeamAssignment#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `RoleId`Required + +```csharp +public string RoleId { get; set; } +``` + +- *Type:* string + +The GitHub organization role id. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team_assignment#role_id OrganizationRoleTeamAssignment#role_id} + +--- + +##### `TeamSlug`Required + +```csharp +public string TeamSlug { get; set; } +``` + +- *Type:* string + +The GitHub team slug. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team_assignment#team_slug OrganizationRoleTeamAssignment#team_slug} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team_assignment#id OrganizationRoleTeamAssignment#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. + +--- + + + diff --git a/docs/organizationRoleTeamAssignment.java.md b/docs/organizationRoleTeamAssignment.java.md new file mode 100644 index 000000000..c17b362d8 --- /dev/null +++ b/docs/organizationRoleTeamAssignment.java.md @@ -0,0 +1,1001 @@ +# `organizationRoleTeamAssignment` Submodule + +## Constructs + +### OrganizationRoleTeamAssignment + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team_assignment github_organization_role_team_assignment}. + +#### Initializers + +```java +import io.cdktn.providers.github.organization_role_team_assignment.OrganizationRoleTeamAssignment; + +OrganizationRoleTeamAssignment.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .roleId(java.lang.String) + .teamSlug(java.lang.String) +// .id(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 | *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 | *No description.* | +| roleId | java.lang.String | The GitHub organization role id. | +| teamSlug | java.lang.String | The GitHub team slug. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team_assignment#id OrganizationRoleTeamAssignment#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `roleId`Required + +- *Type:* java.lang.String + +The GitHub organization role id. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team_assignment#role_id OrganizationRoleTeamAssignment#role_id} + +--- + +##### `teamSlug`Required + +- *Type:* java.lang.String + +The GitHub team slug. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team_assignment#team_slug OrganizationRoleTeamAssignment#team_slug} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team_assignment#id OrganizationRoleTeamAssignment#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a OrganizationRoleTeamAssignment resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.organization_role_team_assignment.OrganizationRoleTeamAssignment; + +OrganizationRoleTeamAssignment.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` + +```java +import io.cdktn.providers.github.organization_role_team_assignment.OrganizationRoleTeamAssignment; + +OrganizationRoleTeamAssignment.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.organization_role_team_assignment.OrganizationRoleTeamAssignment; + +OrganizationRoleTeamAssignment.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.organization_role_team_assignment.OrganizationRoleTeamAssignment; + +OrganizationRoleTeamAssignment.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),OrganizationRoleTeamAssignment.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a OrganizationRoleTeamAssignment 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 OrganizationRoleTeamAssignment to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing OrganizationRoleTeamAssignment that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team_assignment#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 OrganizationRoleTeamAssignment 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| idInput | java.lang.String | *No description.* | +| roleIdInput | java.lang.String | *No description.* | +| teamSlugInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| roleId | java.lang.String | *No description.* | +| teamSlug | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `roleIdInput`Optional + +```java +public java.lang.String getRoleIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `teamSlugInput`Optional + +```java +public java.lang.String getTeamSlugInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `roleId`Required + +```java +public java.lang.String getRoleId(); +``` + +- *Type:* java.lang.String + +--- + +##### `teamSlug`Required + +```java +public java.lang.String getTeamSlug(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### OrganizationRoleTeamAssignmentConfig + +#### Initializer + +```java +import io.cdktn.providers.github.organization_role_team_assignment.OrganizationRoleTeamAssignmentConfig; + +OrganizationRoleTeamAssignmentConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .roleId(java.lang.String) + .teamSlug(java.lang.String) +// .id(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 | *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 | *No description.* | +| roleId | java.lang.String | The GitHub organization role id. | +| teamSlug | java.lang.String | The GitHub team slug. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team_assignment#id OrganizationRoleTeamAssignment#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `roleId`Required + +```java +public java.lang.String getRoleId(); +``` + +- *Type:* java.lang.String + +The GitHub organization role id. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team_assignment#role_id OrganizationRoleTeamAssignment#role_id} + +--- + +##### `teamSlug`Required + +```java +public java.lang.String getTeamSlug(); +``` + +- *Type:* java.lang.String + +The GitHub team slug. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_team_assignment#team_slug OrganizationRoleTeamAssignment#team_slug} + +--- + +##### `id`Optional + +```java +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/resources/organization_role_team_assignment#id OrganizationRoleTeamAssignment#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. + +--- + + + diff --git a/docs/organizationRoleUser.csharp.md b/docs/organizationRoleUser.csharp.md new file mode 100644 index 000000000..3d1cbdcea --- /dev/null +++ b/docs/organizationRoleUser.csharp.md @@ -0,0 +1,912 @@ +# `organizationRoleUser` Submodule + +## Constructs + +### OrganizationRoleUser + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_user github_organization_role_user}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRoleUser(Construct Scope, string Id, OrganizationRoleUserConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | OrganizationRoleUserConfig | *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:* OrganizationRoleUserConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a OrganizationRoleUser resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRoleUser.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` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRoleUser.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRoleUser.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRoleUser.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a OrganizationRoleUser resource upon running "cdktn 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 OrganizationRoleUser to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing OrganizationRoleUser that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_user#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the OrganizationRoleUser to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| IdInput | string | *No description.* | +| LoginInput | string | *No description.* | +| RoleIdInput | double | *No description.* | +| Id | string | *No description.* | +| Login | string | *No description.* | +| RoleId | double | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `LoginInput`Optional + +```csharp +public string LoginInput { get; } +``` + +- *Type:* string + +--- + +##### `RoleIdInput`Optional + +```csharp +public double RoleIdInput { get; } +``` + +- *Type:* double + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Login`Required + +```csharp +public string Login { get; } +``` + +- *Type:* string + +--- + +##### `RoleId`Required + +```csharp +public double RoleId { get; } +``` + +- *Type:* double + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### OrganizationRoleUserConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRoleUserConfig { + 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 Login, + double RoleId, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Login | string | The login for the GitHub user account. | +| RoleId | double | The unique identifier of the organization role. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_user#id OrganizationRoleUser#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Login`Required + +```csharp +public string Login { get; set; } +``` + +- *Type:* string + +The login for the GitHub user account. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_user#login OrganizationRoleUser#login} + +--- + +##### `RoleId`Required + +```csharp +public double RoleId { get; set; } +``` + +- *Type:* double + +The unique identifier of the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_user#role_id OrganizationRoleUser#role_id} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_user#id OrganizationRoleUser#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. + +--- + + + diff --git a/docs/organizationRoleUser.java.md b/docs/organizationRoleUser.java.md new file mode 100644 index 000000000..fb3ae07bb --- /dev/null +++ b/docs/organizationRoleUser.java.md @@ -0,0 +1,1001 @@ +# `organizationRoleUser` Submodule + +## Constructs + +### OrganizationRoleUser + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_user github_organization_role_user}. + +#### Initializers + +```java +import io.cdktn.providers.github.organization_role_user.OrganizationRoleUser; + +OrganizationRoleUser.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .login(java.lang.String) + .roleId(java.lang.Number) +// .id(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 | *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 | *No description.* | +| login | java.lang.String | The login for the GitHub user account. | +| roleId | java.lang.Number | The unique identifier of the organization role. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_user#id OrganizationRoleUser#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `login`Required + +- *Type:* java.lang.String + +The login for the GitHub user account. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_user#login OrganizationRoleUser#login} + +--- + +##### `roleId`Required + +- *Type:* java.lang.Number + +The unique identifier of the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_user#role_id OrganizationRoleUser#role_id} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_user#id OrganizationRoleUser#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a OrganizationRoleUser resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.organization_role_user.OrganizationRoleUser; + +OrganizationRoleUser.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` + +```java +import io.cdktn.providers.github.organization_role_user.OrganizationRoleUser; + +OrganizationRoleUser.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.organization_role_user.OrganizationRoleUser; + +OrganizationRoleUser.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.organization_role_user.OrganizationRoleUser; + +OrganizationRoleUser.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),OrganizationRoleUser.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a OrganizationRoleUser 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 OrganizationRoleUser to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing OrganizationRoleUser that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_user#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 OrganizationRoleUser 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| idInput | java.lang.String | *No description.* | +| loginInput | java.lang.String | *No description.* | +| roleIdInput | java.lang.Number | *No description.* | +| id | java.lang.String | *No description.* | +| login | java.lang.String | *No description.* | +| roleId | java.lang.Number | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `loginInput`Optional + +```java +public java.lang.String getLoginInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `roleIdInput`Optional + +```java +public java.lang.Number getRoleIdInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `login`Required + +```java +public java.lang.String getLogin(); +``` + +- *Type:* java.lang.String + +--- + +##### `roleId`Required + +```java +public java.lang.Number getRoleId(); +``` + +- *Type:* java.lang.Number + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### OrganizationRoleUserConfig + +#### Initializer + +```java +import io.cdktn.providers.github.organization_role_user.OrganizationRoleUserConfig; + +OrganizationRoleUserConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .login(java.lang.String) + .roleId(java.lang.Number) +// .id(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 | *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 | *No description.* | +| login | java.lang.String | The login for the GitHub user account. | +| roleId | java.lang.Number | The unique identifier of the organization role. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_user#id OrganizationRoleUser#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `login`Required + +```java +public java.lang.String getLogin(); +``` + +- *Type:* java.lang.String + +The login for the GitHub user account. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_user#login OrganizationRoleUser#login} + +--- + +##### `roleId`Required + +```java +public java.lang.Number getRoleId(); +``` + +- *Type:* java.lang.Number + +The unique identifier of the organization role. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_role_user#role_id OrganizationRoleUser#role_id} + +--- + +##### `id`Optional + +```java +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/resources/organization_role_user#id OrganizationRoleUser#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. + +--- + + + diff --git a/docs/organizationRuleset.csharp.md b/docs/organizationRuleset.csharp.md new file mode 100644 index 000000000..2d6b3454e --- /dev/null +++ b/docs/organizationRuleset.csharp.md @@ -0,0 +1,13829 @@ +# `organizationRuleset` Submodule + +## Constructs + +### OrganizationRuleset + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset github_organization_ruleset}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRuleset(Construct Scope, string Id, OrganizationRulesetConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | OrganizationRulesetConfig | *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:* OrganizationRulesetConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| PutBypassActors | *No description.* | +| PutConditions | *No description.* | +| PutRules | *No description.* | +| ResetBypassActors | *No description.* | +| ResetConditions | *No description.* | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `PutBypassActors` + +```csharp +private void PutBypassActors(IResolvable|OrganizationRulesetBypassActors[] Value) +``` + +###### `Value`Required + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetBypassActors[] + +--- + +##### `PutConditions` + +```csharp +private void PutConditions(OrganizationRulesetConditions Value) +``` + +###### `Value`Required + +- *Type:* OrganizationRulesetConditions + +--- + +##### `PutRules` + +```csharp +private void PutRules(OrganizationRulesetRules Value) +``` + +###### `Value`Required + +- *Type:* OrganizationRulesetRules + +--- + +##### `ResetBypassActors` + +```csharp +private void ResetBypassActors() +``` + +##### `ResetConditions` + +```csharp +private void ResetConditions() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a OrganizationRuleset resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRuleset.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` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRuleset.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRuleset.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationRuleset.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a OrganizationRuleset resource upon running "cdktn 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 OrganizationRuleset to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing OrganizationRuleset that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the OrganizationRuleset to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| BypassActors | OrganizationRulesetBypassActorsList | *No description.* | +| Conditions | OrganizationRulesetConditionsOutputReference | *No description.* | +| Etag | string | *No description.* | +| NodeId | string | *No description.* | +| Rules | OrganizationRulesetRulesOutputReference | *No description.* | +| RulesetId | double | *No description.* | +| BypassActorsInput | Io.Cdktn.IResolvable\|OrganizationRulesetBypassActors[] | *No description.* | +| ConditionsInput | OrganizationRulesetConditions | *No description.* | +| EnforcementInput | string | *No description.* | +| IdInput | string | *No description.* | +| NameInput | string | *No description.* | +| RulesInput | OrganizationRulesetRules | *No description.* | +| TargetInput | string | *No description.* | +| Enforcement | string | *No description.* | +| Id | string | *No description.* | +| Name | string | *No description.* | +| Target | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `BypassActors`Required + +```csharp +public OrganizationRulesetBypassActorsList BypassActors { get; } +``` + +- *Type:* OrganizationRulesetBypassActorsList + +--- + +##### `Conditions`Required + +```csharp +public OrganizationRulesetConditionsOutputReference Conditions { get; } +``` + +- *Type:* OrganizationRulesetConditionsOutputReference + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `NodeId`Required + +```csharp +public string NodeId { get; } +``` + +- *Type:* string + +--- + +##### `Rules`Required + +```csharp +public OrganizationRulesetRulesOutputReference Rules { get; } +``` + +- *Type:* OrganizationRulesetRulesOutputReference + +--- + +##### `RulesetId`Required + +```csharp +public double RulesetId { get; } +``` + +- *Type:* double + +--- + +##### `BypassActorsInput`Optional + +```csharp +public IResolvable|OrganizationRulesetBypassActors[] BypassActorsInput { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetBypassActors[] + +--- + +##### `ConditionsInput`Optional + +```csharp +public OrganizationRulesetConditions ConditionsInput { get; } +``` + +- *Type:* OrganizationRulesetConditions + +--- + +##### `EnforcementInput`Optional + +```csharp +public string EnforcementInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `RulesInput`Optional + +```csharp +public OrganizationRulesetRules RulesInput { get; } +``` + +- *Type:* OrganizationRulesetRules + +--- + +##### `TargetInput`Optional + +```csharp +public string TargetInput { get; } +``` + +- *Type:* string + +--- + +##### `Enforcement`Required + +```csharp +public string Enforcement { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Target`Required + +```csharp +public string Target { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### OrganizationRulesetBypassActors + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetBypassActors { + string ActorType, + string BypassMode, + double ActorId = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ActorType | string | The type of actor that can bypass a ruleset. Can be one of: `Integration`, `OrganizationAdmin`, `RepositoryRole`, `Team`, or `DeployKey`. | +| BypassMode | string | When the specified actor can bypass the ruleset. | +| ActorId | double | The ID of the actor that can bypass a ruleset. | + +--- + +##### `ActorType`Required + +```csharp +public string ActorType { get; set; } +``` + +- *Type:* string + +The type of actor that can bypass a ruleset. Can be one of: `Integration`, `OrganizationAdmin`, `RepositoryRole`, `Team`, or `DeployKey`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#actor_type OrganizationRuleset#actor_type} + +--- + +##### `BypassMode`Required + +```csharp +public string BypassMode { get; set; } +``` + +- *Type:* string + +When the specified actor can bypass the ruleset. + +pull_request means that an actor can only bypass rules on pull requests. Can be one of: `always`, `pull_request`, `exempt`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#bypass_mode OrganizationRuleset#bypass_mode} + +--- + +##### `ActorId`Optional + +```csharp +public double ActorId { get; set; } +``` + +- *Type:* double + +The ID of the actor that can bypass a ruleset. + +When `actor_type` is `OrganizationAdmin`, this should be set to `1`. Some resources such as DeployKey do not have an ID and this should be omitted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#actor_id OrganizationRuleset#actor_id} + +--- + +### OrganizationRulesetConditions + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetConditions { + OrganizationRulesetConditionsRefName RefName = null, + double[] RepositoryId = null, + OrganizationRulesetConditionsRepositoryName RepositoryName = null, + OrganizationRulesetConditionsRepositoryProperty RepositoryProperty = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| RefName | OrganizationRulesetConditionsRefName | ref_name block. | +| RepositoryId | double[] | The repository IDs that the ruleset applies to. One of these IDs must match for the ruleset to apply. | +| RepositoryName | OrganizationRulesetConditionsRepositoryName | repository_name block. | +| RepositoryProperty | OrganizationRulesetConditionsRepositoryProperty | repository_property block. | + +--- + +##### `RefName`Optional + +```csharp +public OrganizationRulesetConditionsRefName RefName { get; set; } +``` + +- *Type:* OrganizationRulesetConditionsRefName + +ref_name block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#ref_name OrganizationRuleset#ref_name} + +--- + +##### `RepositoryId`Optional + +```csharp +public double[] RepositoryId { get; set; } +``` + +- *Type:* double[] + +The repository IDs that the ruleset applies to. One of these IDs must match for the ruleset to apply. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#repository_id OrganizationRuleset#repository_id} + +--- + +##### `RepositoryName`Optional + +```csharp +public OrganizationRulesetConditionsRepositoryName RepositoryName { get; set; } +``` + +- *Type:* OrganizationRulesetConditionsRepositoryName + +repository_name block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#repository_name OrganizationRuleset#repository_name} + +--- + +##### `RepositoryProperty`Optional + +```csharp +public OrganizationRulesetConditionsRepositoryProperty RepositoryProperty { get; set; } +``` + +- *Type:* OrganizationRulesetConditionsRepositoryProperty + +repository_property block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#repository_property OrganizationRuleset#repository_property} + +--- + +### OrganizationRulesetConditionsRefName + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetConditionsRefName { + string[] Exclude, + string[] Include +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Exclude | string[] | Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. | +| Include | string[] | Array of ref names or patterns to include. | + +--- + +##### `Exclude`Required + +```csharp +public string[] Exclude { get; set; } +``` + +- *Type:* string[] + +Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#exclude OrganizationRuleset#exclude} + +--- + +##### `Include`Required + +```csharp +public string[] Include { get; set; } +``` + +- *Type:* string[] + +Array of ref names or patterns to include. + +One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#include OrganizationRuleset#include} + +--- + +### OrganizationRulesetConditionsRepositoryName + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetConditionsRepositoryName { + string[] Exclude, + string[] Include, + bool|IResolvable Protected = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Exclude | string[] | Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. | +| Include | string[] | Array of repository names or patterns to include. | +| Protected | bool\|Io.Cdktn.IResolvable | Whether renaming of target repositories is prevented. | + +--- + +##### `Exclude`Required + +```csharp +public string[] Exclude { get; set; } +``` + +- *Type:* string[] + +Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#exclude OrganizationRuleset#exclude} + +--- + +##### `Include`Required + +```csharp +public string[] Include { get; set; } +``` + +- *Type:* string[] + +Array of repository names or patterns to include. + +One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#include OrganizationRuleset#include} + +--- + +##### `Protected`Optional + +```csharp +public bool|IResolvable Protected { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether renaming of target repositories is prevented. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#protected OrganizationRuleset#protected} + +--- + +### OrganizationRulesetConditionsRepositoryProperty + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetConditionsRepositoryProperty { + IResolvable|OrganizationRulesetConditionsRepositoryPropertyExclude[] Exclude = null, + IResolvable|OrganizationRulesetConditionsRepositoryPropertyInclude[] Include = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Exclude | Io.Cdktn.IResolvable\|OrganizationRulesetConditionsRepositoryPropertyExclude[] | The repository properties and values to exclude. The ruleset will not apply if any of these properties match. | +| Include | Io.Cdktn.IResolvable\|OrganizationRulesetConditionsRepositoryPropertyInclude[] | The repository properties and values to include. All of these properties must match for the condition to pass. | + +--- + +##### `Exclude`Optional + +```csharp +public IResolvable|OrganizationRulesetConditionsRepositoryPropertyExclude[] Exclude { get; set; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetConditionsRepositoryPropertyExclude[] + +The repository properties and values to exclude. The ruleset will not apply if any of these properties match. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#exclude OrganizationRuleset#exclude} + +--- + +##### `Include`Optional + +```csharp +public IResolvable|OrganizationRulesetConditionsRepositoryPropertyInclude[] Include { get; set; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetConditionsRepositoryPropertyInclude[] + +The repository properties and values to include. All of these properties must match for the condition to pass. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#include OrganizationRuleset#include} + +--- + +### OrganizationRulesetConditionsRepositoryPropertyExclude + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetConditionsRepositoryPropertyExclude { + string Name = null, + string[] PropertyValues = null, + string Source = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Name | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#name OrganizationRuleset#name}. | +| PropertyValues | string[] | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#property_values OrganizationRuleset#property_values}. | +| Source | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#source OrganizationRuleset#source}. | + +--- + +##### `Name`Optional + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#name OrganizationRuleset#name}. + +--- + +##### `PropertyValues`Optional + +```csharp +public string[] PropertyValues { get; set; } +``` + +- *Type:* string[] + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#property_values OrganizationRuleset#property_values}. + +--- + +##### `Source`Optional + +```csharp +public string Source { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#source OrganizationRuleset#source}. + +--- + +### OrganizationRulesetConditionsRepositoryPropertyInclude + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetConditionsRepositoryPropertyInclude { + string Name = null, + string[] PropertyValues = null, + string Source = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Name | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#name OrganizationRuleset#name}. | +| PropertyValues | string[] | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#property_values OrganizationRuleset#property_values}. | +| Source | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#source OrganizationRuleset#source}. | + +--- + +##### `Name`Optional + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#name OrganizationRuleset#name}. + +--- + +##### `PropertyValues`Optional + +```csharp +public string[] PropertyValues { get; set; } +``` + +- *Type:* string[] + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#property_values OrganizationRuleset#property_values}. + +--- + +##### `Source`Optional + +```csharp +public string Source { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#source OrganizationRuleset#source}. + +--- + +### OrganizationRulesetConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetConfig { + 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 Enforcement, + string Name, + OrganizationRulesetRules Rules, + string Target, + IResolvable|OrganizationRulesetBypassActors[] BypassActors = null, + OrganizationRulesetConditions Conditions = null, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Enforcement | string | The enforcement level of the ruleset. | +| Name | string | The name of the ruleset. | +| Rules | OrganizationRulesetRules | rules block. | +| Target | string | The target of the ruleset. Possible values are branch, tag and push. | +| BypassActors | Io.Cdktn.IResolvable\|OrganizationRulesetBypassActors[] | bypass_actors block. | +| Conditions | OrganizationRulesetConditions | conditions block. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#id OrganizationRuleset#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Enforcement`Required + +```csharp +public string Enforcement { get; set; } +``` + +- *Type:* string + +The enforcement level of the ruleset. + +`evaluate` allows admins to test rules before enforcing them. Possible values are `disabled`, `active`, and `evaluate`. Note: `evaluate` is only available for Enterprise plans. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#enforcement OrganizationRuleset#enforcement} + +--- + +##### `Name`Required + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +The name of the ruleset. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#name OrganizationRuleset#name} + +--- + +##### `Rules`Required + +```csharp +public OrganizationRulesetRules Rules { get; set; } +``` + +- *Type:* OrganizationRulesetRules + +rules block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#rules OrganizationRuleset#rules} + +--- + +##### `Target`Required + +```csharp +public string Target { get; set; } +``` + +- *Type:* string + +The target of the ruleset. Possible values are branch, tag and push. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#target OrganizationRuleset#target} + +--- + +##### `BypassActors`Optional + +```csharp +public IResolvable|OrganizationRulesetBypassActors[] BypassActors { get; set; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetBypassActors[] + +bypass_actors block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#bypass_actors OrganizationRuleset#bypass_actors} + +--- + +##### `Conditions`Optional + +```csharp +public OrganizationRulesetConditions Conditions { get; set; } +``` + +- *Type:* OrganizationRulesetConditions + +conditions block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#conditions OrganizationRuleset#conditions} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#id OrganizationRuleset#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. + +--- + +### OrganizationRulesetRules + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRules { + OrganizationRulesetRulesBranchNamePattern BranchNamePattern = null, + OrganizationRulesetRulesCommitAuthorEmailPattern CommitAuthorEmailPattern = null, + OrganizationRulesetRulesCommitMessagePattern CommitMessagePattern = null, + OrganizationRulesetRulesCommitterEmailPattern CommitterEmailPattern = null, + OrganizationRulesetRulesCopilotCodeReview CopilotCodeReview = null, + bool|IResolvable Creation = null, + bool|IResolvable Deletion = null, + OrganizationRulesetRulesFileExtensionRestriction FileExtensionRestriction = null, + OrganizationRulesetRulesFilePathRestriction FilePathRestriction = null, + OrganizationRulesetRulesMaxFilePathLength MaxFilePathLength = null, + OrganizationRulesetRulesMaxFileSize MaxFileSize = null, + bool|IResolvable NonFastForward = null, + OrganizationRulesetRulesPullRequest PullRequest = null, + OrganizationRulesetRulesRequiredCodeScanning RequiredCodeScanning = null, + bool|IResolvable RequiredLinearHistory = null, + bool|IResolvable RequiredSignatures = null, + OrganizationRulesetRulesRequiredStatusChecks RequiredStatusChecks = null, + OrganizationRulesetRulesRequiredWorkflows RequiredWorkflows = null, + OrganizationRulesetRulesTagNamePattern TagNamePattern = null, + bool|IResolvable Update = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| BranchNamePattern | OrganizationRulesetRulesBranchNamePattern | branch_name_pattern block. | +| CommitAuthorEmailPattern | OrganizationRulesetRulesCommitAuthorEmailPattern | commit_author_email_pattern block. | +| CommitMessagePattern | OrganizationRulesetRulesCommitMessagePattern | commit_message_pattern block. | +| CommitterEmailPattern | OrganizationRulesetRulesCommitterEmailPattern | committer_email_pattern block. | +| CopilotCodeReview | OrganizationRulesetRulesCopilotCodeReview | copilot_code_review block. | +| Creation | bool\|Io.Cdktn.IResolvable | Only allow users with bypass permission to create matching refs. | +| Deletion | bool\|Io.Cdktn.IResolvable | Only allow users with bypass permissions to delete matching refs. | +| FileExtensionRestriction | OrganizationRulesetRulesFileExtensionRestriction | file_extension_restriction block. | +| FilePathRestriction | OrganizationRulesetRulesFilePathRestriction | file_path_restriction block. | +| MaxFilePathLength | OrganizationRulesetRulesMaxFilePathLength | max_file_path_length block. | +| MaxFileSize | OrganizationRulesetRulesMaxFileSize | max_file_size block. | +| NonFastForward | bool\|Io.Cdktn.IResolvable | Prevent users with push access from force pushing to refs. | +| PullRequest | OrganizationRulesetRulesPullRequest | pull_request block. | +| RequiredCodeScanning | OrganizationRulesetRulesRequiredCodeScanning | required_code_scanning block. | +| RequiredLinearHistory | bool\|Io.Cdktn.IResolvable | Prevent merge commits from being pushed to matching branches. | +| RequiredSignatures | bool\|Io.Cdktn.IResolvable | Commits pushed to matching branches must have verified signatures. | +| RequiredStatusChecks | OrganizationRulesetRulesRequiredStatusChecks | required_status_checks block. | +| RequiredWorkflows | OrganizationRulesetRulesRequiredWorkflows | required_workflows block. | +| TagNamePattern | OrganizationRulesetRulesTagNamePattern | tag_name_pattern block. | +| Update | bool\|Io.Cdktn.IResolvable | Only allow users with bypass permission to update matching refs. | + +--- + +##### `BranchNamePattern`Optional + +```csharp +public OrganizationRulesetRulesBranchNamePattern BranchNamePattern { get; set; } +``` + +- *Type:* OrganizationRulesetRulesBranchNamePattern + +branch_name_pattern block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#branch_name_pattern OrganizationRuleset#branch_name_pattern} + +--- + +##### `CommitAuthorEmailPattern`Optional + +```csharp +public OrganizationRulesetRulesCommitAuthorEmailPattern CommitAuthorEmailPattern { get; set; } +``` + +- *Type:* OrganizationRulesetRulesCommitAuthorEmailPattern + +commit_author_email_pattern block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#commit_author_email_pattern OrganizationRuleset#commit_author_email_pattern} + +--- + +##### `CommitMessagePattern`Optional + +```csharp +public OrganizationRulesetRulesCommitMessagePattern CommitMessagePattern { get; set; } +``` + +- *Type:* OrganizationRulesetRulesCommitMessagePattern + +commit_message_pattern block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#commit_message_pattern OrganizationRuleset#commit_message_pattern} + +--- + +##### `CommitterEmailPattern`Optional + +```csharp +public OrganizationRulesetRulesCommitterEmailPattern CommitterEmailPattern { get; set; } +``` + +- *Type:* OrganizationRulesetRulesCommitterEmailPattern + +committer_email_pattern block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#committer_email_pattern OrganizationRuleset#committer_email_pattern} + +--- + +##### `CopilotCodeReview`Optional + +```csharp +public OrganizationRulesetRulesCopilotCodeReview CopilotCodeReview { get; set; } +``` + +- *Type:* OrganizationRulesetRulesCopilotCodeReview + +copilot_code_review block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#copilot_code_review OrganizationRuleset#copilot_code_review} + +--- + +##### `Creation`Optional + +```csharp +public bool|IResolvable Creation { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Only allow users with bypass permission to create matching refs. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#creation OrganizationRuleset#creation} + +--- + +##### `Deletion`Optional + +```csharp +public bool|IResolvable Deletion { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Only allow users with bypass permissions to delete matching refs. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#deletion OrganizationRuleset#deletion} + +--- + +##### `FileExtensionRestriction`Optional + +```csharp +public OrganizationRulesetRulesFileExtensionRestriction FileExtensionRestriction { get; set; } +``` + +- *Type:* OrganizationRulesetRulesFileExtensionRestriction + +file_extension_restriction block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#file_extension_restriction OrganizationRuleset#file_extension_restriction} + +--- + +##### `FilePathRestriction`Optional + +```csharp +public OrganizationRulesetRulesFilePathRestriction FilePathRestriction { get; set; } +``` + +- *Type:* OrganizationRulesetRulesFilePathRestriction + +file_path_restriction block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#file_path_restriction OrganizationRuleset#file_path_restriction} + +--- + +##### `MaxFilePathLength`Optional + +```csharp +public OrganizationRulesetRulesMaxFilePathLength MaxFilePathLength { get; set; } +``` + +- *Type:* OrganizationRulesetRulesMaxFilePathLength + +max_file_path_length block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#max_file_path_length OrganizationRuleset#max_file_path_length} + +--- + +##### `MaxFileSize`Optional + +```csharp +public OrganizationRulesetRulesMaxFileSize MaxFileSize { get; set; } +``` + +- *Type:* OrganizationRulesetRulesMaxFileSize + +max_file_size block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#max_file_size OrganizationRuleset#max_file_size} + +--- + +##### `NonFastForward`Optional + +```csharp +public bool|IResolvable NonFastForward { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Prevent users with push access from force pushing to refs. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#non_fast_forward OrganizationRuleset#non_fast_forward} + +--- + +##### `PullRequest`Optional + +```csharp +public OrganizationRulesetRulesPullRequest PullRequest { get; set; } +``` + +- *Type:* OrganizationRulesetRulesPullRequest + +pull_request block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#pull_request OrganizationRuleset#pull_request} + +--- + +##### `RequiredCodeScanning`Optional + +```csharp +public OrganizationRulesetRulesRequiredCodeScanning RequiredCodeScanning { get; set; } +``` + +- *Type:* OrganizationRulesetRulesRequiredCodeScanning + +required_code_scanning block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#required_code_scanning OrganizationRuleset#required_code_scanning} + +--- + +##### `RequiredLinearHistory`Optional + +```csharp +public bool|IResolvable RequiredLinearHistory { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Prevent merge commits from being pushed to matching branches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#required_linear_history OrganizationRuleset#required_linear_history} + +--- + +##### `RequiredSignatures`Optional + +```csharp +public bool|IResolvable RequiredSignatures { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Commits pushed to matching branches must have verified signatures. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#required_signatures OrganizationRuleset#required_signatures} + +--- + +##### `RequiredStatusChecks`Optional + +```csharp +public OrganizationRulesetRulesRequiredStatusChecks RequiredStatusChecks { get; set; } +``` + +- *Type:* OrganizationRulesetRulesRequiredStatusChecks + +required_status_checks block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#required_status_checks OrganizationRuleset#required_status_checks} + +--- + +##### `RequiredWorkflows`Optional + +```csharp +public OrganizationRulesetRulesRequiredWorkflows RequiredWorkflows { get; set; } +``` + +- *Type:* OrganizationRulesetRulesRequiredWorkflows + +required_workflows block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#required_workflows OrganizationRuleset#required_workflows} + +--- + +##### `TagNamePattern`Optional + +```csharp +public OrganizationRulesetRulesTagNamePattern TagNamePattern { get; set; } +``` + +- *Type:* OrganizationRulesetRulesTagNamePattern + +tag_name_pattern block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#tag_name_pattern OrganizationRuleset#tag_name_pattern} + +--- + +##### `Update`Optional + +```csharp +public bool|IResolvable Update { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Only allow users with bypass permission to update matching refs. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#update OrganizationRuleset#update} + +--- + +### OrganizationRulesetRulesBranchNamePattern + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesBranchNamePattern { + string Operator, + string Pattern, + string Name = null, + bool|IResolvable Negate = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Operator | string | The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. | +| Pattern | string | The pattern to match with. | +| Name | string | How this rule will appear to users. | +| Negate | bool\|Io.Cdktn.IResolvable | If true, the rule will fail if the pattern matches. | + +--- + +##### `Operator`Required + +```csharp +public string Operator { get; set; } +``` + +- *Type:* string + +The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#operator OrganizationRuleset#operator} + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; set; } +``` + +- *Type:* string + +The pattern to match with. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#pattern OrganizationRuleset#pattern} + +--- + +##### `Name`Optional + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +How this rule will appear to users. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#name OrganizationRuleset#name} + +--- + +##### `Negate`Optional + +```csharp +public bool|IResolvable Negate { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +If true, the rule will fail if the pattern matches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#negate OrganizationRuleset#negate} + +--- + +### OrganizationRulesetRulesCommitAuthorEmailPattern + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesCommitAuthorEmailPattern { + string Operator, + string Pattern, + string Name = null, + bool|IResolvable Negate = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Operator | string | The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. | +| Pattern | string | The pattern to match with. | +| Name | string | How this rule will appear to users. | +| Negate | bool\|Io.Cdktn.IResolvable | If true, the rule will fail if the pattern matches. | + +--- + +##### `Operator`Required + +```csharp +public string Operator { get; set; } +``` + +- *Type:* string + +The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#operator OrganizationRuleset#operator} + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; set; } +``` + +- *Type:* string + +The pattern to match with. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#pattern OrganizationRuleset#pattern} + +--- + +##### `Name`Optional + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +How this rule will appear to users. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#name OrganizationRuleset#name} + +--- + +##### `Negate`Optional + +```csharp +public bool|IResolvable Negate { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +If true, the rule will fail if the pattern matches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#negate OrganizationRuleset#negate} + +--- + +### OrganizationRulesetRulesCommitMessagePattern + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesCommitMessagePattern { + string Operator, + string Pattern, + string Name = null, + bool|IResolvable Negate = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Operator | string | The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. | +| Pattern | string | The pattern to match with. | +| Name | string | How this rule will appear to users. | +| Negate | bool\|Io.Cdktn.IResolvable | If true, the rule will fail if the pattern matches. | + +--- + +##### `Operator`Required + +```csharp +public string Operator { get; set; } +``` + +- *Type:* string + +The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#operator OrganizationRuleset#operator} + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; set; } +``` + +- *Type:* string + +The pattern to match with. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#pattern OrganizationRuleset#pattern} + +--- + +##### `Name`Optional + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +How this rule will appear to users. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#name OrganizationRuleset#name} + +--- + +##### `Negate`Optional + +```csharp +public bool|IResolvable Negate { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +If true, the rule will fail if the pattern matches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#negate OrganizationRuleset#negate} + +--- + +### OrganizationRulesetRulesCommitterEmailPattern + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesCommitterEmailPattern { + string Operator, + string Pattern, + string Name = null, + bool|IResolvable Negate = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Operator | string | The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. | +| Pattern | string | The pattern to match with. | +| Name | string | How this rule will appear to users. | +| Negate | bool\|Io.Cdktn.IResolvable | If true, the rule will fail if the pattern matches. | + +--- + +##### `Operator`Required + +```csharp +public string Operator { get; set; } +``` + +- *Type:* string + +The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#operator OrganizationRuleset#operator} + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; set; } +``` + +- *Type:* string + +The pattern to match with. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#pattern OrganizationRuleset#pattern} + +--- + +##### `Name`Optional + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +How this rule will appear to users. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#name OrganizationRuleset#name} + +--- + +##### `Negate`Optional + +```csharp +public bool|IResolvable Negate { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +If true, the rule will fail if the pattern matches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#negate OrganizationRuleset#negate} + +--- + +### OrganizationRulesetRulesCopilotCodeReview + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesCopilotCodeReview { + bool|IResolvable ReviewDraftPullRequests = null, + bool|IResolvable ReviewOnPush = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ReviewDraftPullRequests | bool\|Io.Cdktn.IResolvable | Copilot automatically reviews draft pull requests before they are marked as ready for review. Defaults to `false`. | +| ReviewOnPush | bool\|Io.Cdktn.IResolvable | Copilot automatically reviews each new push to the pull request. Defaults to `false`. | + +--- + +##### `ReviewDraftPullRequests`Optional + +```csharp +public bool|IResolvable ReviewDraftPullRequests { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Copilot automatically reviews draft pull requests before they are marked as ready for review. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#review_draft_pull_requests OrganizationRuleset#review_draft_pull_requests} + +--- + +##### `ReviewOnPush`Optional + +```csharp +public bool|IResolvable ReviewOnPush { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Copilot automatically reviews each new push to the pull request. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#review_on_push OrganizationRuleset#review_on_push} + +--- + +### OrganizationRulesetRulesFileExtensionRestriction + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesFileExtensionRestriction { + string[] RestrictedFileExtensions +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| RestrictedFileExtensions | string[] | The file extensions that are restricted from being pushed to the commit graph. | + +--- + +##### `RestrictedFileExtensions`Required + +```csharp +public string[] RestrictedFileExtensions { get; set; } +``` + +- *Type:* string[] + +The file extensions that are restricted from being pushed to the commit graph. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#restricted_file_extensions OrganizationRuleset#restricted_file_extensions} + +--- + +### OrganizationRulesetRulesFilePathRestriction + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesFilePathRestriction { + string[] RestrictedFilePaths +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| RestrictedFilePaths | string[] | The file paths that are restricted from being pushed to the commit graph. | + +--- + +##### `RestrictedFilePaths`Required + +```csharp +public string[] RestrictedFilePaths { get; set; } +``` + +- *Type:* string[] + +The file paths that are restricted from being pushed to the commit graph. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#restricted_file_paths OrganizationRuleset#restricted_file_paths} + +--- + +### OrganizationRulesetRulesMaxFilePathLength + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesMaxFilePathLength { + double MaxFilePathLength +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| MaxFilePathLength | double | The maximum allowed length of a file path. | + +--- + +##### `MaxFilePathLength`Required + +```csharp +public double MaxFilePathLength { get; set; } +``` + +- *Type:* double + +The maximum allowed length of a file path. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#max_file_path_length OrganizationRuleset#max_file_path_length} + +--- + +### OrganizationRulesetRulesMaxFileSize + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesMaxFileSize { + double MaxFileSize +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| MaxFileSize | double | The maximum allowed size of a file in megabytes (MB). Valid range is 1-100 MB. | + +--- + +##### `MaxFileSize`Required + +```csharp +public double MaxFileSize { get; set; } +``` + +- *Type:* double + +The maximum allowed size of a file in megabytes (MB). Valid range is 1-100 MB. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#max_file_size OrganizationRuleset#max_file_size} + +--- + +### OrganizationRulesetRulesPullRequest + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesPullRequest { + string[] AllowedMergeMethods = null, + bool|IResolvable DismissStaleReviewsOnPush = null, + bool|IResolvable RequireCodeOwnerReview = null, + double RequiredApprovingReviewCount = null, + IResolvable|OrganizationRulesetRulesPullRequestRequiredReviewers[] RequiredReviewers = null, + bool|IResolvable RequiredReviewThreadResolution = null, + bool|IResolvable RequireLastPushApproval = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| AllowedMergeMethods | string[] | Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled. | +| DismissStaleReviewsOnPush | bool\|Io.Cdktn.IResolvable | New, reviewable commits pushed will dismiss previous pull request review approvals. Defaults to `false`. | +| RequireCodeOwnerReview | bool\|Io.Cdktn.IResolvable | Require an approving review in pull requests that modify files that have a designated code owner. Defaults to `false`. | +| RequiredApprovingReviewCount | double | The number of approving reviews that are required before a pull request can be merged. Defaults to `0`. | +| RequiredReviewers | Io.Cdktn.IResolvable\|OrganizationRulesetRulesPullRequestRequiredReviewers[] | required_reviewers block. | +| RequiredReviewThreadResolution | bool\|Io.Cdktn.IResolvable | All conversations on code must be resolved before a pull request can be merged. Defaults to `false`. | +| RequireLastPushApproval | bool\|Io.Cdktn.IResolvable | Whether the most recent reviewable push must be approved by someone other than the person who pushed it. | + +--- + +##### `AllowedMergeMethods`Optional + +```csharp +public string[] AllowedMergeMethods { get; set; } +``` + +- *Type:* string[] + +Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#allowed_merge_methods OrganizationRuleset#allowed_merge_methods} + +--- + +##### `DismissStaleReviewsOnPush`Optional + +```csharp +public bool|IResolvable DismissStaleReviewsOnPush { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +New, reviewable commits pushed will dismiss previous pull request review approvals. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#dismiss_stale_reviews_on_push OrganizationRuleset#dismiss_stale_reviews_on_push} + +--- + +##### `RequireCodeOwnerReview`Optional + +```csharp +public bool|IResolvable RequireCodeOwnerReview { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Require an approving review in pull requests that modify files that have a designated code owner. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#require_code_owner_review OrganizationRuleset#require_code_owner_review} + +--- + +##### `RequiredApprovingReviewCount`Optional + +```csharp +public double RequiredApprovingReviewCount { get; set; } +``` + +- *Type:* double + +The number of approving reviews that are required before a pull request can be merged. Defaults to `0`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#required_approving_review_count OrganizationRuleset#required_approving_review_count} + +--- + +##### `RequiredReviewers`Optional + +```csharp +public IResolvable|OrganizationRulesetRulesPullRequestRequiredReviewers[] RequiredReviewers { get; set; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetRulesPullRequestRequiredReviewers[] + +required_reviewers block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#required_reviewers OrganizationRuleset#required_reviewers} + +--- + +##### `RequiredReviewThreadResolution`Optional + +```csharp +public bool|IResolvable RequiredReviewThreadResolution { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +All conversations on code must be resolved before a pull request can be merged. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#required_review_thread_resolution OrganizationRuleset#required_review_thread_resolution} + +--- + +##### `RequireLastPushApproval`Optional + +```csharp +public bool|IResolvable RequireLastPushApproval { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether the most recent reviewable push must be approved by someone other than the person who pushed it. + +Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#require_last_push_approval OrganizationRuleset#require_last_push_approval} + +--- + +### OrganizationRulesetRulesPullRequestRequiredReviewers + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesPullRequestRequiredReviewers { + string[] FilePatterns, + double MinimumApprovals, + OrganizationRulesetRulesPullRequestRequiredReviewersReviewer Reviewer +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| FilePatterns | string[] | File patterns (fnmatch syntax) that this reviewer must approve. | +| MinimumApprovals | double | Minimum number of approvals required from this reviewer. Set to 0 to make approval optional. | +| Reviewer | OrganizationRulesetRulesPullRequestRequiredReviewersReviewer | reviewer block. | + +--- + +##### `FilePatterns`Required + +```csharp +public string[] FilePatterns { get; set; } +``` + +- *Type:* string[] + +File patterns (fnmatch syntax) that this reviewer must approve. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#file_patterns OrganizationRuleset#file_patterns} + +--- + +##### `MinimumApprovals`Required + +```csharp +public double MinimumApprovals { get; set; } +``` + +- *Type:* double + +Minimum number of approvals required from this reviewer. Set to 0 to make approval optional. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#minimum_approvals OrganizationRuleset#minimum_approvals} + +--- + +##### `Reviewer`Required + +```csharp +public OrganizationRulesetRulesPullRequestRequiredReviewersReviewer Reviewer { get; set; } +``` + +- *Type:* OrganizationRulesetRulesPullRequestRequiredReviewersReviewer + +reviewer block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#reviewer OrganizationRuleset#reviewer} + +--- + +### OrganizationRulesetRulesPullRequestRequiredReviewersReviewer + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesPullRequestRequiredReviewersReviewer { + double Id, + string Type +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Id | double | The ID of the reviewer that must review. | +| Type | string | The type of reviewer. Currently only `Team` is supported. | + +--- + +##### `Id`Required + +```csharp +public double Id { get; set; } +``` + +- *Type:* double + +The ID of the reviewer that must review. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#id OrganizationRuleset#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`Required + +```csharp +public string Type { get; set; } +``` + +- *Type:* string + +The type of reviewer. Currently only `Team` is supported. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#type OrganizationRuleset#type} + +--- + +### OrganizationRulesetRulesRequiredCodeScanning + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesRequiredCodeScanning { + IResolvable|OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] RequiredCodeScanningTool +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| RequiredCodeScanningTool | Io.Cdktn.IResolvable\|OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] | required_code_scanning_tool block. | + +--- + +##### `RequiredCodeScanningTool`Required + +```csharp +public IResolvable|OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] RequiredCodeScanningTool { get; set; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] + +required_code_scanning_tool block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#required_code_scanning_tool OrganizationRuleset#required_code_scanning_tool} + +--- + +### OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool { + string AlertsThreshold, + string SecurityAlertsThreshold, + string Tool +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| AlertsThreshold | string | The severity level at which code scanning results that raise alerts block a reference update. | +| SecurityAlertsThreshold | string | The severity level at which code scanning results that raise security alerts block a reference update. | +| Tool | string | The name of a code scanning tool. | + +--- + +##### `AlertsThreshold`Required + +```csharp +public string AlertsThreshold { get; set; } +``` + +- *Type:* string + +The severity level at which code scanning results that raise alerts block a reference update. + +Can be one of: `none`, `errors`, `errors_and_warnings`, `all`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#alerts_threshold OrganizationRuleset#alerts_threshold} + +--- + +##### `SecurityAlertsThreshold`Required + +```csharp +public string SecurityAlertsThreshold { get; set; } +``` + +- *Type:* string + +The severity level at which code scanning results that raise security alerts block a reference update. + +Can be one of: `none`, `critical`, `high_or_higher`, `medium_or_higher`, `all`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#security_alerts_threshold OrganizationRuleset#security_alerts_threshold} + +--- + +##### `Tool`Required + +```csharp +public string Tool { get; set; } +``` + +- *Type:* string + +The name of a code scanning tool. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#tool OrganizationRuleset#tool} + +--- + +### OrganizationRulesetRulesRequiredStatusChecks + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesRequiredStatusChecks { + IResolvable|OrganizationRulesetRulesRequiredStatusChecksRequiredCheck[] RequiredCheck, + bool|IResolvable DoNotEnforceOnCreate = null, + bool|IResolvable StrictRequiredStatusChecksPolicy = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| RequiredCheck | Io.Cdktn.IResolvable\|OrganizationRulesetRulesRequiredStatusChecksRequiredCheck[] | required_check block. | +| DoNotEnforceOnCreate | bool\|Io.Cdktn.IResolvable | Allow repositories and branches to be created if a check would otherwise prohibit it. | +| StrictRequiredStatusChecksPolicy | bool\|Io.Cdktn.IResolvable | Whether pull requests targeting a matching branch must be tested with the latest code. | + +--- + +##### `RequiredCheck`Required + +```csharp +public IResolvable|OrganizationRulesetRulesRequiredStatusChecksRequiredCheck[] RequiredCheck { get; set; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetRulesRequiredStatusChecksRequiredCheck[] + +required_check block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#required_check OrganizationRuleset#required_check} + +--- + +##### `DoNotEnforceOnCreate`Optional + +```csharp +public bool|IResolvable DoNotEnforceOnCreate { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Allow repositories and branches to be created if a check would otherwise prohibit it. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#do_not_enforce_on_create OrganizationRuleset#do_not_enforce_on_create} + +--- + +##### `StrictRequiredStatusChecksPolicy`Optional + +```csharp +public bool|IResolvable StrictRequiredStatusChecksPolicy { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether pull requests targeting a matching branch must be tested with the latest code. + +This setting will not take effect unless at least one status check is enabled. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#strict_required_status_checks_policy OrganizationRuleset#strict_required_status_checks_policy} + +--- + +### OrganizationRulesetRulesRequiredStatusChecksRequiredCheck + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesRequiredStatusChecksRequiredCheck { + string Context, + double IntegrationId = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Context | string | The status check context name that must be present on the commit. | +| IntegrationId | double | The optional integration ID that this status check must originate from. | + +--- + +##### `Context`Required + +```csharp +public string Context { get; set; } +``` + +- *Type:* string + +The status check context name that must be present on the commit. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#context OrganizationRuleset#context} + +--- + +##### `IntegrationId`Optional + +```csharp +public double IntegrationId { get; set; } +``` + +- *Type:* double + +The optional integration ID that this status check must originate from. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#integration_id OrganizationRuleset#integration_id} + +--- + +### OrganizationRulesetRulesRequiredWorkflows + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesRequiredWorkflows { + IResolvable|OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow[] RequiredWorkflow, + bool|IResolvable DoNotEnforceOnCreate = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| RequiredWorkflow | Io.Cdktn.IResolvable\|OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow[] | required_workflow block. | +| DoNotEnforceOnCreate | bool\|Io.Cdktn.IResolvable | Allow repositories and branches to be created if a check would otherwise prohibit it. | + +--- + +##### `RequiredWorkflow`Required + +```csharp +public IResolvable|OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow[] RequiredWorkflow { get; set; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow[] + +required_workflow block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#required_workflow OrganizationRuleset#required_workflow} + +--- + +##### `DoNotEnforceOnCreate`Optional + +```csharp +public bool|IResolvable DoNotEnforceOnCreate { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Allow repositories and branches to be created if a check would otherwise prohibit it. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#do_not_enforce_on_create OrganizationRuleset#do_not_enforce_on_create} + +--- + +### OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow { + string Path, + double RepositoryId, + string Ref = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Path | string | The path to the workflow YAML definition file. | +| RepositoryId | double | The repository in which the workflow is defined. | +| Ref | string | The ref (branch or tag) of the workflow file to use. | + +--- + +##### `Path`Required + +```csharp +public string Path { get; set; } +``` + +- *Type:* string + +The path to the workflow YAML definition file. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#path OrganizationRuleset#path} + +--- + +##### `RepositoryId`Required + +```csharp +public double RepositoryId { get; set; } +``` + +- *Type:* double + +The repository in which the workflow is defined. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#repository_id OrganizationRuleset#repository_id} + +--- + +##### `Ref`Optional + +```csharp +public string Ref { get; set; } +``` + +- *Type:* string + +The ref (branch or tag) of the workflow file to use. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#ref OrganizationRuleset#ref} + +--- + +### OrganizationRulesetRulesTagNamePattern + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesTagNamePattern { + string Operator, + string Pattern, + string Name = null, + bool|IResolvable Negate = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Operator | string | The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. | +| Pattern | string | The pattern to match with. | +| Name | string | How this rule will appear to users. | +| Negate | bool\|Io.Cdktn.IResolvable | If true, the rule will fail if the pattern matches. | + +--- + +##### `Operator`Required + +```csharp +public string Operator { get; set; } +``` + +- *Type:* string + +The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#operator OrganizationRuleset#operator} + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; set; } +``` + +- *Type:* string + +The pattern to match with. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#pattern OrganizationRuleset#pattern} + +--- + +##### `Name`Optional + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +How this rule will appear to users. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#name OrganizationRuleset#name} + +--- + +##### `Negate`Optional + +```csharp +public bool|IResolvable Negate { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +If true, the rule will fail if the pattern matches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#negate OrganizationRuleset#negate} + +--- + +## Classes + +### OrganizationRulesetBypassActorsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetBypassActorsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private OrganizationRulesetBypassActorsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|OrganizationRulesetBypassActors[] | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|OrganizationRulesetBypassActors[] InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetBypassActors[] + +--- + + +### OrganizationRulesetBypassActorsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetBypassActorsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetActorId | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetActorId` + +```csharp +private void ResetActorId() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| ActorIdInput | double | *No description.* | +| ActorTypeInput | string | *No description.* | +| BypassModeInput | string | *No description.* | +| ActorId | double | *No description.* | +| ActorType | string | *No description.* | +| BypassMode | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|OrganizationRulesetBypassActors | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `ActorIdInput`Optional + +```csharp +public double ActorIdInput { get; } +``` + +- *Type:* double + +--- + +##### `ActorTypeInput`Optional + +```csharp +public string ActorTypeInput { get; } +``` + +- *Type:* string + +--- + +##### `BypassModeInput`Optional + +```csharp +public string BypassModeInput { get; } +``` + +- *Type:* string + +--- + +##### `ActorId`Required + +```csharp +public double ActorId { get; } +``` + +- *Type:* double + +--- + +##### `ActorType`Required + +```csharp +public string ActorType { get; } +``` + +- *Type:* string + +--- + +##### `BypassMode`Required + +```csharp +public string BypassMode { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|OrganizationRulesetBypassActors InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetBypassActors + +--- + + +### OrganizationRulesetConditionsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetConditionsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| PutRefName | *No description.* | +| PutRepositoryName | *No description.* | +| PutRepositoryProperty | *No description.* | +| ResetRefName | *No description.* | +| ResetRepositoryId | *No description.* | +| ResetRepositoryName | *No description.* | +| ResetRepositoryProperty | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `PutRefName` + +```csharp +private void PutRefName(OrganizationRulesetConditionsRefName Value) +``` + +###### `Value`Required + +- *Type:* OrganizationRulesetConditionsRefName + +--- + +##### `PutRepositoryName` + +```csharp +private void PutRepositoryName(OrganizationRulesetConditionsRepositoryName Value) +``` + +###### `Value`Required + +- *Type:* OrganizationRulesetConditionsRepositoryName + +--- + +##### `PutRepositoryProperty` + +```csharp +private void PutRepositoryProperty(OrganizationRulesetConditionsRepositoryProperty Value) +``` + +###### `Value`Required + +- *Type:* OrganizationRulesetConditionsRepositoryProperty + +--- + +##### `ResetRefName` + +```csharp +private void ResetRefName() +``` + +##### `ResetRepositoryId` + +```csharp +private void ResetRepositoryId() +``` + +##### `ResetRepositoryName` + +```csharp +private void ResetRepositoryName() +``` + +##### `ResetRepositoryProperty` + +```csharp +private void ResetRepositoryProperty() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| RefName | OrganizationRulesetConditionsRefNameOutputReference | *No description.* | +| RepositoryName | OrganizationRulesetConditionsRepositoryNameOutputReference | *No description.* | +| RepositoryProperty | OrganizationRulesetConditionsRepositoryPropertyOutputReference | *No description.* | +| RefNameInput | OrganizationRulesetConditionsRefName | *No description.* | +| RepositoryIdInput | double[] | *No description.* | +| RepositoryNameInput | OrganizationRulesetConditionsRepositoryName | *No description.* | +| RepositoryPropertyInput | OrganizationRulesetConditionsRepositoryProperty | *No description.* | +| RepositoryId | double[] | *No description.* | +| InternalValue | OrganizationRulesetConditions | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `RefName`Required + +```csharp +public OrganizationRulesetConditionsRefNameOutputReference RefName { get; } +``` + +- *Type:* OrganizationRulesetConditionsRefNameOutputReference + +--- + +##### `RepositoryName`Required + +```csharp +public OrganizationRulesetConditionsRepositoryNameOutputReference RepositoryName { get; } +``` + +- *Type:* OrganizationRulesetConditionsRepositoryNameOutputReference + +--- + +##### `RepositoryProperty`Required + +```csharp +public OrganizationRulesetConditionsRepositoryPropertyOutputReference RepositoryProperty { get; } +``` + +- *Type:* OrganizationRulesetConditionsRepositoryPropertyOutputReference + +--- + +##### `RefNameInput`Optional + +```csharp +public OrganizationRulesetConditionsRefName RefNameInput { get; } +``` + +- *Type:* OrganizationRulesetConditionsRefName + +--- + +##### `RepositoryIdInput`Optional + +```csharp +public double[] RepositoryIdInput { get; } +``` + +- *Type:* double[] + +--- + +##### `RepositoryNameInput`Optional + +```csharp +public OrganizationRulesetConditionsRepositoryName RepositoryNameInput { get; } +``` + +- *Type:* OrganizationRulesetConditionsRepositoryName + +--- + +##### `RepositoryPropertyInput`Optional + +```csharp +public OrganizationRulesetConditionsRepositoryProperty RepositoryPropertyInput { get; } +``` + +- *Type:* OrganizationRulesetConditionsRepositoryProperty + +--- + +##### `RepositoryId`Required + +```csharp +public double[] RepositoryId { get; } +``` + +- *Type:* double[] + +--- + +##### `InternalValue`Optional + +```csharp +public OrganizationRulesetConditions InternalValue { get; } +``` + +- *Type:* OrganizationRulesetConditions + +--- + + +### OrganizationRulesetConditionsRefNameOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetConditionsRefNameOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| ExcludeInput | string[] | *No description.* | +| IncludeInput | string[] | *No description.* | +| Exclude | string[] | *No description.* | +| Include | string[] | *No description.* | +| InternalValue | OrganizationRulesetConditionsRefName | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `ExcludeInput`Optional + +```csharp +public string[] ExcludeInput { get; } +``` + +- *Type:* string[] + +--- + +##### `IncludeInput`Optional + +```csharp +public string[] IncludeInput { get; } +``` + +- *Type:* string[] + +--- + +##### `Exclude`Required + +```csharp +public string[] Exclude { get; } +``` + +- *Type:* string[] + +--- + +##### `Include`Required + +```csharp +public string[] Include { get; } +``` + +- *Type:* string[] + +--- + +##### `InternalValue`Optional + +```csharp +public OrganizationRulesetConditionsRefName InternalValue { get; } +``` + +- *Type:* OrganizationRulesetConditionsRefName + +--- + + +### OrganizationRulesetConditionsRepositoryNameOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetConditionsRepositoryNameOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetProtected | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetProtected` + +```csharp +private void ResetProtected() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| ExcludeInput | string[] | *No description.* | +| IncludeInput | string[] | *No description.* | +| ProtectedInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| Exclude | string[] | *No description.* | +| Include | string[] | *No description.* | +| Protected | bool\|Io.Cdktn.IResolvable | *No description.* | +| InternalValue | OrganizationRulesetConditionsRepositoryName | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `ExcludeInput`Optional + +```csharp +public string[] ExcludeInput { get; } +``` + +- *Type:* string[] + +--- + +##### `IncludeInput`Optional + +```csharp +public string[] IncludeInput { get; } +``` + +- *Type:* string[] + +--- + +##### `ProtectedInput`Optional + +```csharp +public bool|IResolvable ProtectedInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Exclude`Required + +```csharp +public string[] Exclude { get; } +``` + +- *Type:* string[] + +--- + +##### `Include`Required + +```csharp +public string[] Include { get; } +``` + +- *Type:* string[] + +--- + +##### `Protected`Required + +```csharp +public bool|IResolvable Protected { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `InternalValue`Optional + +```csharp +public OrganizationRulesetConditionsRepositoryName InternalValue { get; } +``` + +- *Type:* OrganizationRulesetConditionsRepositoryName + +--- + + +### OrganizationRulesetConditionsRepositoryPropertyExcludeList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetConditionsRepositoryPropertyExcludeList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private OrganizationRulesetConditionsRepositoryPropertyExcludeOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|OrganizationRulesetConditionsRepositoryPropertyExclude[] | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|OrganizationRulesetConditionsRepositoryPropertyExclude[] InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetConditionsRepositoryPropertyExclude[] + +--- + + +### OrganizationRulesetConditionsRepositoryPropertyExcludeOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetConditionsRepositoryPropertyExcludeOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetName | *No description.* | +| ResetPropertyValues | *No description.* | +| ResetSource | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetName` + +```csharp +private void ResetName() +``` + +##### `ResetPropertyValues` + +```csharp +private void ResetPropertyValues() +``` + +##### `ResetSource` + +```csharp +private void ResetSource() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| NameInput | string | *No description.* | +| PropertyValuesInput | string[] | *No description.* | +| SourceInput | string | *No description.* | +| Name | string | *No description.* | +| PropertyValues | string[] | *No description.* | +| Source | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|OrganizationRulesetConditionsRepositoryPropertyExclude | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `PropertyValuesInput`Optional + +```csharp +public string[] PropertyValuesInput { get; } +``` + +- *Type:* string[] + +--- + +##### `SourceInput`Optional + +```csharp +public string SourceInput { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `PropertyValues`Required + +```csharp +public string[] PropertyValues { get; } +``` + +- *Type:* string[] + +--- + +##### `Source`Required + +```csharp +public string Source { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|OrganizationRulesetConditionsRepositoryPropertyExclude InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetConditionsRepositoryPropertyExclude + +--- + + +### OrganizationRulesetConditionsRepositoryPropertyIncludeList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetConditionsRepositoryPropertyIncludeList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private OrganizationRulesetConditionsRepositoryPropertyIncludeOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|OrganizationRulesetConditionsRepositoryPropertyInclude[] | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|OrganizationRulesetConditionsRepositoryPropertyInclude[] InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetConditionsRepositoryPropertyInclude[] + +--- + + +### OrganizationRulesetConditionsRepositoryPropertyIncludeOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetConditionsRepositoryPropertyIncludeOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetName | *No description.* | +| ResetPropertyValues | *No description.* | +| ResetSource | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetName` + +```csharp +private void ResetName() +``` + +##### `ResetPropertyValues` + +```csharp +private void ResetPropertyValues() +``` + +##### `ResetSource` + +```csharp +private void ResetSource() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| NameInput | string | *No description.* | +| PropertyValuesInput | string[] | *No description.* | +| SourceInput | string | *No description.* | +| Name | string | *No description.* | +| PropertyValues | string[] | *No description.* | +| Source | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|OrganizationRulesetConditionsRepositoryPropertyInclude | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `PropertyValuesInput`Optional + +```csharp +public string[] PropertyValuesInput { get; } +``` + +- *Type:* string[] + +--- + +##### `SourceInput`Optional + +```csharp +public string SourceInput { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `PropertyValues`Required + +```csharp +public string[] PropertyValues { get; } +``` + +- *Type:* string[] + +--- + +##### `Source`Required + +```csharp +public string Source { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|OrganizationRulesetConditionsRepositoryPropertyInclude InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetConditionsRepositoryPropertyInclude + +--- + + +### OrganizationRulesetConditionsRepositoryPropertyOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetConditionsRepositoryPropertyOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| PutExclude | *No description.* | +| PutInclude | *No description.* | +| ResetExclude | *No description.* | +| ResetInclude | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `PutExclude` + +```csharp +private void PutExclude(IResolvable|OrganizationRulesetConditionsRepositoryPropertyExclude[] Value) +``` + +###### `Value`Required + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetConditionsRepositoryPropertyExclude[] + +--- + +##### `PutInclude` + +```csharp +private void PutInclude(IResolvable|OrganizationRulesetConditionsRepositoryPropertyInclude[] Value) +``` + +###### `Value`Required + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetConditionsRepositoryPropertyInclude[] + +--- + +##### `ResetExclude` + +```csharp +private void ResetExclude() +``` + +##### `ResetInclude` + +```csharp +private void ResetInclude() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Exclude | OrganizationRulesetConditionsRepositoryPropertyExcludeList | *No description.* | +| Include | OrganizationRulesetConditionsRepositoryPropertyIncludeList | *No description.* | +| ExcludeInput | Io.Cdktn.IResolvable\|OrganizationRulesetConditionsRepositoryPropertyExclude[] | *No description.* | +| IncludeInput | Io.Cdktn.IResolvable\|OrganizationRulesetConditionsRepositoryPropertyInclude[] | *No description.* | +| InternalValue | OrganizationRulesetConditionsRepositoryProperty | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Exclude`Required + +```csharp +public OrganizationRulesetConditionsRepositoryPropertyExcludeList Exclude { get; } +``` + +- *Type:* OrganizationRulesetConditionsRepositoryPropertyExcludeList + +--- + +##### `Include`Required + +```csharp +public OrganizationRulesetConditionsRepositoryPropertyIncludeList Include { get; } +``` + +- *Type:* OrganizationRulesetConditionsRepositoryPropertyIncludeList + +--- + +##### `ExcludeInput`Optional + +```csharp +public IResolvable|OrganizationRulesetConditionsRepositoryPropertyExclude[] ExcludeInput { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetConditionsRepositoryPropertyExclude[] + +--- + +##### `IncludeInput`Optional + +```csharp +public IResolvable|OrganizationRulesetConditionsRepositoryPropertyInclude[] IncludeInput { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetConditionsRepositoryPropertyInclude[] + +--- + +##### `InternalValue`Optional + +```csharp +public OrganizationRulesetConditionsRepositoryProperty InternalValue { get; } +``` + +- *Type:* OrganizationRulesetConditionsRepositoryProperty + +--- + + +### OrganizationRulesetRulesBranchNamePatternOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesBranchNamePatternOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetName | *No description.* | +| ResetNegate | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetName` + +```csharp +private void ResetName() +``` + +##### `ResetNegate` + +```csharp +private void ResetNegate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| NameInput | string | *No description.* | +| NegateInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| OperatorInput | string | *No description.* | +| PatternInput | string | *No description.* | +| Name | string | *No description.* | +| Negate | bool\|Io.Cdktn.IResolvable | *No description.* | +| Operator | string | *No description.* | +| Pattern | string | *No description.* | +| InternalValue | OrganizationRulesetRulesBranchNamePattern | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `NegateInput`Optional + +```csharp +public bool|IResolvable NegateInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `OperatorInput`Optional + +```csharp +public string OperatorInput { get; } +``` + +- *Type:* string + +--- + +##### `PatternInput`Optional + +```csharp +public string PatternInput { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Negate`Required + +```csharp +public bool|IResolvable Negate { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Operator`Required + +```csharp +public string Operator { get; } +``` + +- *Type:* string + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public OrganizationRulesetRulesBranchNamePattern InternalValue { get; } +``` + +- *Type:* OrganizationRulesetRulesBranchNamePattern + +--- + + +### OrganizationRulesetRulesCommitAuthorEmailPatternOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesCommitAuthorEmailPatternOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetName | *No description.* | +| ResetNegate | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetName` + +```csharp +private void ResetName() +``` + +##### `ResetNegate` + +```csharp +private void ResetNegate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| NameInput | string | *No description.* | +| NegateInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| OperatorInput | string | *No description.* | +| PatternInput | string | *No description.* | +| Name | string | *No description.* | +| Negate | bool\|Io.Cdktn.IResolvable | *No description.* | +| Operator | string | *No description.* | +| Pattern | string | *No description.* | +| InternalValue | OrganizationRulesetRulesCommitAuthorEmailPattern | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `NegateInput`Optional + +```csharp +public bool|IResolvable NegateInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `OperatorInput`Optional + +```csharp +public string OperatorInput { get; } +``` + +- *Type:* string + +--- + +##### `PatternInput`Optional + +```csharp +public string PatternInput { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Negate`Required + +```csharp +public bool|IResolvable Negate { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Operator`Required + +```csharp +public string Operator { get; } +``` + +- *Type:* string + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public OrganizationRulesetRulesCommitAuthorEmailPattern InternalValue { get; } +``` + +- *Type:* OrganizationRulesetRulesCommitAuthorEmailPattern + +--- + + +### OrganizationRulesetRulesCommitMessagePatternOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesCommitMessagePatternOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetName | *No description.* | +| ResetNegate | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetName` + +```csharp +private void ResetName() +``` + +##### `ResetNegate` + +```csharp +private void ResetNegate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| NameInput | string | *No description.* | +| NegateInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| OperatorInput | string | *No description.* | +| PatternInput | string | *No description.* | +| Name | string | *No description.* | +| Negate | bool\|Io.Cdktn.IResolvable | *No description.* | +| Operator | string | *No description.* | +| Pattern | string | *No description.* | +| InternalValue | OrganizationRulesetRulesCommitMessagePattern | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `NegateInput`Optional + +```csharp +public bool|IResolvable NegateInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `OperatorInput`Optional + +```csharp +public string OperatorInput { get; } +``` + +- *Type:* string + +--- + +##### `PatternInput`Optional + +```csharp +public string PatternInput { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Negate`Required + +```csharp +public bool|IResolvable Negate { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Operator`Required + +```csharp +public string Operator { get; } +``` + +- *Type:* string + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public OrganizationRulesetRulesCommitMessagePattern InternalValue { get; } +``` + +- *Type:* OrganizationRulesetRulesCommitMessagePattern + +--- + + +### OrganizationRulesetRulesCommitterEmailPatternOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesCommitterEmailPatternOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetName | *No description.* | +| ResetNegate | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetName` + +```csharp +private void ResetName() +``` + +##### `ResetNegate` + +```csharp +private void ResetNegate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| NameInput | string | *No description.* | +| NegateInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| OperatorInput | string | *No description.* | +| PatternInput | string | *No description.* | +| Name | string | *No description.* | +| Negate | bool\|Io.Cdktn.IResolvable | *No description.* | +| Operator | string | *No description.* | +| Pattern | string | *No description.* | +| InternalValue | OrganizationRulesetRulesCommitterEmailPattern | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `NegateInput`Optional + +```csharp +public bool|IResolvable NegateInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `OperatorInput`Optional + +```csharp +public string OperatorInput { get; } +``` + +- *Type:* string + +--- + +##### `PatternInput`Optional + +```csharp +public string PatternInput { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Negate`Required + +```csharp +public bool|IResolvable Negate { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Operator`Required + +```csharp +public string Operator { get; } +``` + +- *Type:* string + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public OrganizationRulesetRulesCommitterEmailPattern InternalValue { get; } +``` + +- *Type:* OrganizationRulesetRulesCommitterEmailPattern + +--- + + +### OrganizationRulesetRulesCopilotCodeReviewOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesCopilotCodeReviewOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetReviewDraftPullRequests | *No description.* | +| ResetReviewOnPush | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetReviewDraftPullRequests` + +```csharp +private void ResetReviewDraftPullRequests() +``` + +##### `ResetReviewOnPush` + +```csharp +private void ResetReviewOnPush() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| ReviewDraftPullRequestsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| ReviewOnPushInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| ReviewDraftPullRequests | bool\|Io.Cdktn.IResolvable | *No description.* | +| ReviewOnPush | bool\|Io.Cdktn.IResolvable | *No description.* | +| InternalValue | OrganizationRulesetRulesCopilotCodeReview | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `ReviewDraftPullRequestsInput`Optional + +```csharp +public bool|IResolvable ReviewDraftPullRequestsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ReviewOnPushInput`Optional + +```csharp +public bool|IResolvable ReviewOnPushInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ReviewDraftPullRequests`Required + +```csharp +public bool|IResolvable ReviewDraftPullRequests { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ReviewOnPush`Required + +```csharp +public bool|IResolvable ReviewOnPush { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `InternalValue`Optional + +```csharp +public OrganizationRulesetRulesCopilotCodeReview InternalValue { get; } +``` + +- *Type:* OrganizationRulesetRulesCopilotCodeReview + +--- + + +### OrganizationRulesetRulesFileExtensionRestrictionOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesFileExtensionRestrictionOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| RestrictedFileExtensionsInput | string[] | *No description.* | +| RestrictedFileExtensions | string[] | *No description.* | +| InternalValue | OrganizationRulesetRulesFileExtensionRestriction | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `RestrictedFileExtensionsInput`Optional + +```csharp +public string[] RestrictedFileExtensionsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `RestrictedFileExtensions`Required + +```csharp +public string[] RestrictedFileExtensions { get; } +``` + +- *Type:* string[] + +--- + +##### `InternalValue`Optional + +```csharp +public OrganizationRulesetRulesFileExtensionRestriction InternalValue { get; } +``` + +- *Type:* OrganizationRulesetRulesFileExtensionRestriction + +--- + + +### OrganizationRulesetRulesFilePathRestrictionOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesFilePathRestrictionOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| RestrictedFilePathsInput | string[] | *No description.* | +| RestrictedFilePaths | string[] | *No description.* | +| InternalValue | OrganizationRulesetRulesFilePathRestriction | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `RestrictedFilePathsInput`Optional + +```csharp +public string[] RestrictedFilePathsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `RestrictedFilePaths`Required + +```csharp +public string[] RestrictedFilePaths { get; } +``` + +- *Type:* string[] + +--- + +##### `InternalValue`Optional + +```csharp +public OrganizationRulesetRulesFilePathRestriction InternalValue { get; } +``` + +- *Type:* OrganizationRulesetRulesFilePathRestriction + +--- + + +### OrganizationRulesetRulesMaxFilePathLengthOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesMaxFilePathLengthOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| MaxFilePathLengthInput | double | *No description.* | +| MaxFilePathLength | double | *No description.* | +| InternalValue | OrganizationRulesetRulesMaxFilePathLength | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `MaxFilePathLengthInput`Optional + +```csharp +public double MaxFilePathLengthInput { get; } +``` + +- *Type:* double + +--- + +##### `MaxFilePathLength`Required + +```csharp +public double MaxFilePathLength { get; } +``` + +- *Type:* double + +--- + +##### `InternalValue`Optional + +```csharp +public OrganizationRulesetRulesMaxFilePathLength InternalValue { get; } +``` + +- *Type:* OrganizationRulesetRulesMaxFilePathLength + +--- + + +### OrganizationRulesetRulesMaxFileSizeOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesMaxFileSizeOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| MaxFileSizeInput | double | *No description.* | +| MaxFileSize | double | *No description.* | +| InternalValue | OrganizationRulesetRulesMaxFileSize | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `MaxFileSizeInput`Optional + +```csharp +public double MaxFileSizeInput { get; } +``` + +- *Type:* double + +--- + +##### `MaxFileSize`Required + +```csharp +public double MaxFileSize { get; } +``` + +- *Type:* double + +--- + +##### `InternalValue`Optional + +```csharp +public OrganizationRulesetRulesMaxFileSize InternalValue { get; } +``` + +- *Type:* OrganizationRulesetRulesMaxFileSize + +--- + + +### OrganizationRulesetRulesOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| PutBranchNamePattern | *No description.* | +| PutCommitAuthorEmailPattern | *No description.* | +| PutCommitMessagePattern | *No description.* | +| PutCommitterEmailPattern | *No description.* | +| PutCopilotCodeReview | *No description.* | +| PutFileExtensionRestriction | *No description.* | +| PutFilePathRestriction | *No description.* | +| PutMaxFilePathLength | *No description.* | +| PutMaxFileSize | *No description.* | +| PutPullRequest | *No description.* | +| PutRequiredCodeScanning | *No description.* | +| PutRequiredStatusChecks | *No description.* | +| PutRequiredWorkflows | *No description.* | +| PutTagNamePattern | *No description.* | +| ResetBranchNamePattern | *No description.* | +| ResetCommitAuthorEmailPattern | *No description.* | +| ResetCommitMessagePattern | *No description.* | +| ResetCommitterEmailPattern | *No description.* | +| ResetCopilotCodeReview | *No description.* | +| ResetCreation | *No description.* | +| ResetDeletion | *No description.* | +| ResetFileExtensionRestriction | *No description.* | +| ResetFilePathRestriction | *No description.* | +| ResetMaxFilePathLength | *No description.* | +| ResetMaxFileSize | *No description.* | +| ResetNonFastForward | *No description.* | +| ResetPullRequest | *No description.* | +| ResetRequiredCodeScanning | *No description.* | +| ResetRequiredLinearHistory | *No description.* | +| ResetRequiredSignatures | *No description.* | +| ResetRequiredStatusChecks | *No description.* | +| ResetRequiredWorkflows | *No description.* | +| ResetTagNamePattern | *No description.* | +| ResetUpdate | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `PutBranchNamePattern` + +```csharp +private void PutBranchNamePattern(OrganizationRulesetRulesBranchNamePattern Value) +``` + +###### `Value`Required + +- *Type:* OrganizationRulesetRulesBranchNamePattern + +--- + +##### `PutCommitAuthorEmailPattern` + +```csharp +private void PutCommitAuthorEmailPattern(OrganizationRulesetRulesCommitAuthorEmailPattern Value) +``` + +###### `Value`Required + +- *Type:* OrganizationRulesetRulesCommitAuthorEmailPattern + +--- + +##### `PutCommitMessagePattern` + +```csharp +private void PutCommitMessagePattern(OrganizationRulesetRulesCommitMessagePattern Value) +``` + +###### `Value`Required + +- *Type:* OrganizationRulesetRulesCommitMessagePattern + +--- + +##### `PutCommitterEmailPattern` + +```csharp +private void PutCommitterEmailPattern(OrganizationRulesetRulesCommitterEmailPattern Value) +``` + +###### `Value`Required + +- *Type:* OrganizationRulesetRulesCommitterEmailPattern + +--- + +##### `PutCopilotCodeReview` + +```csharp +private void PutCopilotCodeReview(OrganizationRulesetRulesCopilotCodeReview Value) +``` + +###### `Value`Required + +- *Type:* OrganizationRulesetRulesCopilotCodeReview + +--- + +##### `PutFileExtensionRestriction` + +```csharp +private void PutFileExtensionRestriction(OrganizationRulesetRulesFileExtensionRestriction Value) +``` + +###### `Value`Required + +- *Type:* OrganizationRulesetRulesFileExtensionRestriction + +--- + +##### `PutFilePathRestriction` + +```csharp +private void PutFilePathRestriction(OrganizationRulesetRulesFilePathRestriction Value) +``` + +###### `Value`Required + +- *Type:* OrganizationRulesetRulesFilePathRestriction + +--- + +##### `PutMaxFilePathLength` + +```csharp +private void PutMaxFilePathLength(OrganizationRulesetRulesMaxFilePathLength Value) +``` + +###### `Value`Required + +- *Type:* OrganizationRulesetRulesMaxFilePathLength + +--- + +##### `PutMaxFileSize` + +```csharp +private void PutMaxFileSize(OrganizationRulesetRulesMaxFileSize Value) +``` + +###### `Value`Required + +- *Type:* OrganizationRulesetRulesMaxFileSize + +--- + +##### `PutPullRequest` + +```csharp +private void PutPullRequest(OrganizationRulesetRulesPullRequest Value) +``` + +###### `Value`Required + +- *Type:* OrganizationRulesetRulesPullRequest + +--- + +##### `PutRequiredCodeScanning` + +```csharp +private void PutRequiredCodeScanning(OrganizationRulesetRulesRequiredCodeScanning Value) +``` + +###### `Value`Required + +- *Type:* OrganizationRulesetRulesRequiredCodeScanning + +--- + +##### `PutRequiredStatusChecks` + +```csharp +private void PutRequiredStatusChecks(OrganizationRulesetRulesRequiredStatusChecks Value) +``` + +###### `Value`Required + +- *Type:* OrganizationRulesetRulesRequiredStatusChecks + +--- + +##### `PutRequiredWorkflows` + +```csharp +private void PutRequiredWorkflows(OrganizationRulesetRulesRequiredWorkflows Value) +``` + +###### `Value`Required + +- *Type:* OrganizationRulesetRulesRequiredWorkflows + +--- + +##### `PutTagNamePattern` + +```csharp +private void PutTagNamePattern(OrganizationRulesetRulesTagNamePattern Value) +``` + +###### `Value`Required + +- *Type:* OrganizationRulesetRulesTagNamePattern + +--- + +##### `ResetBranchNamePattern` + +```csharp +private void ResetBranchNamePattern() +``` + +##### `ResetCommitAuthorEmailPattern` + +```csharp +private void ResetCommitAuthorEmailPattern() +``` + +##### `ResetCommitMessagePattern` + +```csharp +private void ResetCommitMessagePattern() +``` + +##### `ResetCommitterEmailPattern` + +```csharp +private void ResetCommitterEmailPattern() +``` + +##### `ResetCopilotCodeReview` + +```csharp +private void ResetCopilotCodeReview() +``` + +##### `ResetCreation` + +```csharp +private void ResetCreation() +``` + +##### `ResetDeletion` + +```csharp +private void ResetDeletion() +``` + +##### `ResetFileExtensionRestriction` + +```csharp +private void ResetFileExtensionRestriction() +``` + +##### `ResetFilePathRestriction` + +```csharp +private void ResetFilePathRestriction() +``` + +##### `ResetMaxFilePathLength` + +```csharp +private void ResetMaxFilePathLength() +``` + +##### `ResetMaxFileSize` + +```csharp +private void ResetMaxFileSize() +``` + +##### `ResetNonFastForward` + +```csharp +private void ResetNonFastForward() +``` + +##### `ResetPullRequest` + +```csharp +private void ResetPullRequest() +``` + +##### `ResetRequiredCodeScanning` + +```csharp +private void ResetRequiredCodeScanning() +``` + +##### `ResetRequiredLinearHistory` + +```csharp +private void ResetRequiredLinearHistory() +``` + +##### `ResetRequiredSignatures` + +```csharp +private void ResetRequiredSignatures() +``` + +##### `ResetRequiredStatusChecks` + +```csharp +private void ResetRequiredStatusChecks() +``` + +##### `ResetRequiredWorkflows` + +```csharp +private void ResetRequiredWorkflows() +``` + +##### `ResetTagNamePattern` + +```csharp +private void ResetTagNamePattern() +``` + +##### `ResetUpdate` + +```csharp +private void ResetUpdate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| BranchNamePattern | OrganizationRulesetRulesBranchNamePatternOutputReference | *No description.* | +| CommitAuthorEmailPattern | OrganizationRulesetRulesCommitAuthorEmailPatternOutputReference | *No description.* | +| CommitMessagePattern | OrganizationRulesetRulesCommitMessagePatternOutputReference | *No description.* | +| CommitterEmailPattern | OrganizationRulesetRulesCommitterEmailPatternOutputReference | *No description.* | +| CopilotCodeReview | OrganizationRulesetRulesCopilotCodeReviewOutputReference | *No description.* | +| FileExtensionRestriction | OrganizationRulesetRulesFileExtensionRestrictionOutputReference | *No description.* | +| FilePathRestriction | OrganizationRulesetRulesFilePathRestrictionOutputReference | *No description.* | +| MaxFilePathLength | OrganizationRulesetRulesMaxFilePathLengthOutputReference | *No description.* | +| MaxFileSize | OrganizationRulesetRulesMaxFileSizeOutputReference | *No description.* | +| PullRequest | OrganizationRulesetRulesPullRequestOutputReference | *No description.* | +| RequiredCodeScanning | OrganizationRulesetRulesRequiredCodeScanningOutputReference | *No description.* | +| RequiredStatusChecks | OrganizationRulesetRulesRequiredStatusChecksOutputReference | *No description.* | +| RequiredWorkflows | OrganizationRulesetRulesRequiredWorkflowsOutputReference | *No description.* | +| TagNamePattern | OrganizationRulesetRulesTagNamePatternOutputReference | *No description.* | +| BranchNamePatternInput | OrganizationRulesetRulesBranchNamePattern | *No description.* | +| CommitAuthorEmailPatternInput | OrganizationRulesetRulesCommitAuthorEmailPattern | *No description.* | +| CommitMessagePatternInput | OrganizationRulesetRulesCommitMessagePattern | *No description.* | +| CommitterEmailPatternInput | OrganizationRulesetRulesCommitterEmailPattern | *No description.* | +| CopilotCodeReviewInput | OrganizationRulesetRulesCopilotCodeReview | *No description.* | +| CreationInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| DeletionInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| FileExtensionRestrictionInput | OrganizationRulesetRulesFileExtensionRestriction | *No description.* | +| FilePathRestrictionInput | OrganizationRulesetRulesFilePathRestriction | *No description.* | +| MaxFilePathLengthInput | OrganizationRulesetRulesMaxFilePathLength | *No description.* | +| MaxFileSizeInput | OrganizationRulesetRulesMaxFileSize | *No description.* | +| NonFastForwardInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| PullRequestInput | OrganizationRulesetRulesPullRequest | *No description.* | +| RequiredCodeScanningInput | OrganizationRulesetRulesRequiredCodeScanning | *No description.* | +| RequiredLinearHistoryInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequiredSignaturesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequiredStatusChecksInput | OrganizationRulesetRulesRequiredStatusChecks | *No description.* | +| RequiredWorkflowsInput | OrganizationRulesetRulesRequiredWorkflows | *No description.* | +| TagNamePatternInput | OrganizationRulesetRulesTagNamePattern | *No description.* | +| UpdateInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| Creation | bool\|Io.Cdktn.IResolvable | *No description.* | +| Deletion | bool\|Io.Cdktn.IResolvable | *No description.* | +| NonFastForward | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequiredLinearHistory | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequiredSignatures | bool\|Io.Cdktn.IResolvable | *No description.* | +| Update | bool\|Io.Cdktn.IResolvable | *No description.* | +| InternalValue | OrganizationRulesetRules | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `BranchNamePattern`Required + +```csharp +public OrganizationRulesetRulesBranchNamePatternOutputReference BranchNamePattern { get; } +``` + +- *Type:* OrganizationRulesetRulesBranchNamePatternOutputReference + +--- + +##### `CommitAuthorEmailPattern`Required + +```csharp +public OrganizationRulesetRulesCommitAuthorEmailPatternOutputReference CommitAuthorEmailPattern { get; } +``` + +- *Type:* OrganizationRulesetRulesCommitAuthorEmailPatternOutputReference + +--- + +##### `CommitMessagePattern`Required + +```csharp +public OrganizationRulesetRulesCommitMessagePatternOutputReference CommitMessagePattern { get; } +``` + +- *Type:* OrganizationRulesetRulesCommitMessagePatternOutputReference + +--- + +##### `CommitterEmailPattern`Required + +```csharp +public OrganizationRulesetRulesCommitterEmailPatternOutputReference CommitterEmailPattern { get; } +``` + +- *Type:* OrganizationRulesetRulesCommitterEmailPatternOutputReference + +--- + +##### `CopilotCodeReview`Required + +```csharp +public OrganizationRulesetRulesCopilotCodeReviewOutputReference CopilotCodeReview { get; } +``` + +- *Type:* OrganizationRulesetRulesCopilotCodeReviewOutputReference + +--- + +##### `FileExtensionRestriction`Required + +```csharp +public OrganizationRulesetRulesFileExtensionRestrictionOutputReference FileExtensionRestriction { get; } +``` + +- *Type:* OrganizationRulesetRulesFileExtensionRestrictionOutputReference + +--- + +##### `FilePathRestriction`Required + +```csharp +public OrganizationRulesetRulesFilePathRestrictionOutputReference FilePathRestriction { get; } +``` + +- *Type:* OrganizationRulesetRulesFilePathRestrictionOutputReference + +--- + +##### `MaxFilePathLength`Required + +```csharp +public OrganizationRulesetRulesMaxFilePathLengthOutputReference MaxFilePathLength { get; } +``` + +- *Type:* OrganizationRulesetRulesMaxFilePathLengthOutputReference + +--- + +##### `MaxFileSize`Required + +```csharp +public OrganizationRulesetRulesMaxFileSizeOutputReference MaxFileSize { get; } +``` + +- *Type:* OrganizationRulesetRulesMaxFileSizeOutputReference + +--- + +##### `PullRequest`Required + +```csharp +public OrganizationRulesetRulesPullRequestOutputReference PullRequest { get; } +``` + +- *Type:* OrganizationRulesetRulesPullRequestOutputReference + +--- + +##### `RequiredCodeScanning`Required + +```csharp +public OrganizationRulesetRulesRequiredCodeScanningOutputReference RequiredCodeScanning { get; } +``` + +- *Type:* OrganizationRulesetRulesRequiredCodeScanningOutputReference + +--- + +##### `RequiredStatusChecks`Required + +```csharp +public OrganizationRulesetRulesRequiredStatusChecksOutputReference RequiredStatusChecks { get; } +``` + +- *Type:* OrganizationRulesetRulesRequiredStatusChecksOutputReference + +--- + +##### `RequiredWorkflows`Required + +```csharp +public OrganizationRulesetRulesRequiredWorkflowsOutputReference RequiredWorkflows { get; } +``` + +- *Type:* OrganizationRulesetRulesRequiredWorkflowsOutputReference + +--- + +##### `TagNamePattern`Required + +```csharp +public OrganizationRulesetRulesTagNamePatternOutputReference TagNamePattern { get; } +``` + +- *Type:* OrganizationRulesetRulesTagNamePatternOutputReference + +--- + +##### `BranchNamePatternInput`Optional + +```csharp +public OrganizationRulesetRulesBranchNamePattern BranchNamePatternInput { get; } +``` + +- *Type:* OrganizationRulesetRulesBranchNamePattern + +--- + +##### `CommitAuthorEmailPatternInput`Optional + +```csharp +public OrganizationRulesetRulesCommitAuthorEmailPattern CommitAuthorEmailPatternInput { get; } +``` + +- *Type:* OrganizationRulesetRulesCommitAuthorEmailPattern + +--- + +##### `CommitMessagePatternInput`Optional + +```csharp +public OrganizationRulesetRulesCommitMessagePattern CommitMessagePatternInput { get; } +``` + +- *Type:* OrganizationRulesetRulesCommitMessagePattern + +--- + +##### `CommitterEmailPatternInput`Optional + +```csharp +public OrganizationRulesetRulesCommitterEmailPattern CommitterEmailPatternInput { get; } +``` + +- *Type:* OrganizationRulesetRulesCommitterEmailPattern + +--- + +##### `CopilotCodeReviewInput`Optional + +```csharp +public OrganizationRulesetRulesCopilotCodeReview CopilotCodeReviewInput { get; } +``` + +- *Type:* OrganizationRulesetRulesCopilotCodeReview + +--- + +##### `CreationInput`Optional + +```csharp +public bool|IResolvable CreationInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `DeletionInput`Optional + +```csharp +public bool|IResolvable DeletionInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `FileExtensionRestrictionInput`Optional + +```csharp +public OrganizationRulesetRulesFileExtensionRestriction FileExtensionRestrictionInput { get; } +``` + +- *Type:* OrganizationRulesetRulesFileExtensionRestriction + +--- + +##### `FilePathRestrictionInput`Optional + +```csharp +public OrganizationRulesetRulesFilePathRestriction FilePathRestrictionInput { get; } +``` + +- *Type:* OrganizationRulesetRulesFilePathRestriction + +--- + +##### `MaxFilePathLengthInput`Optional + +```csharp +public OrganizationRulesetRulesMaxFilePathLength MaxFilePathLengthInput { get; } +``` + +- *Type:* OrganizationRulesetRulesMaxFilePathLength + +--- + +##### `MaxFileSizeInput`Optional + +```csharp +public OrganizationRulesetRulesMaxFileSize MaxFileSizeInput { get; } +``` + +- *Type:* OrganizationRulesetRulesMaxFileSize + +--- + +##### `NonFastForwardInput`Optional + +```csharp +public bool|IResolvable NonFastForwardInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `PullRequestInput`Optional + +```csharp +public OrganizationRulesetRulesPullRequest PullRequestInput { get; } +``` + +- *Type:* OrganizationRulesetRulesPullRequest + +--- + +##### `RequiredCodeScanningInput`Optional + +```csharp +public OrganizationRulesetRulesRequiredCodeScanning RequiredCodeScanningInput { get; } +``` + +- *Type:* OrganizationRulesetRulesRequiredCodeScanning + +--- + +##### `RequiredLinearHistoryInput`Optional + +```csharp +public bool|IResolvable RequiredLinearHistoryInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequiredSignaturesInput`Optional + +```csharp +public bool|IResolvable RequiredSignaturesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequiredStatusChecksInput`Optional + +```csharp +public OrganizationRulesetRulesRequiredStatusChecks RequiredStatusChecksInput { get; } +``` + +- *Type:* OrganizationRulesetRulesRequiredStatusChecks + +--- + +##### `RequiredWorkflowsInput`Optional + +```csharp +public OrganizationRulesetRulesRequiredWorkflows RequiredWorkflowsInput { get; } +``` + +- *Type:* OrganizationRulesetRulesRequiredWorkflows + +--- + +##### `TagNamePatternInput`Optional + +```csharp +public OrganizationRulesetRulesTagNamePattern TagNamePatternInput { get; } +``` + +- *Type:* OrganizationRulesetRulesTagNamePattern + +--- + +##### `UpdateInput`Optional + +```csharp +public bool|IResolvable UpdateInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Creation`Required + +```csharp +public bool|IResolvable Creation { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Deletion`Required + +```csharp +public bool|IResolvable Deletion { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `NonFastForward`Required + +```csharp +public bool|IResolvable NonFastForward { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequiredLinearHistory`Required + +```csharp +public bool|IResolvable RequiredLinearHistory { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequiredSignatures`Required + +```csharp +public bool|IResolvable RequiredSignatures { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Update`Required + +```csharp +public bool|IResolvable Update { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `InternalValue`Optional + +```csharp +public OrganizationRulesetRules InternalValue { get; } +``` + +- *Type:* OrganizationRulesetRules + +--- + + +### OrganizationRulesetRulesPullRequestOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesPullRequestOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| PutRequiredReviewers | *No description.* | +| ResetAllowedMergeMethods | *No description.* | +| ResetDismissStaleReviewsOnPush | *No description.* | +| ResetRequireCodeOwnerReview | *No description.* | +| ResetRequiredApprovingReviewCount | *No description.* | +| ResetRequiredReviewers | *No description.* | +| ResetRequiredReviewThreadResolution | *No description.* | +| ResetRequireLastPushApproval | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `PutRequiredReviewers` + +```csharp +private void PutRequiredReviewers(IResolvable|OrganizationRulesetRulesPullRequestRequiredReviewers[] Value) +``` + +###### `Value`Required + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetRulesPullRequestRequiredReviewers[] + +--- + +##### `ResetAllowedMergeMethods` + +```csharp +private void ResetAllowedMergeMethods() +``` + +##### `ResetDismissStaleReviewsOnPush` + +```csharp +private void ResetDismissStaleReviewsOnPush() +``` + +##### `ResetRequireCodeOwnerReview` + +```csharp +private void ResetRequireCodeOwnerReview() +``` + +##### `ResetRequiredApprovingReviewCount` + +```csharp +private void ResetRequiredApprovingReviewCount() +``` + +##### `ResetRequiredReviewers` + +```csharp +private void ResetRequiredReviewers() +``` + +##### `ResetRequiredReviewThreadResolution` + +```csharp +private void ResetRequiredReviewThreadResolution() +``` + +##### `ResetRequireLastPushApproval` + +```csharp +private void ResetRequireLastPushApproval() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| RequiredReviewers | OrganizationRulesetRulesPullRequestRequiredReviewersList | *No description.* | +| AllowedMergeMethodsInput | string[] | *No description.* | +| DismissStaleReviewsOnPushInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequireCodeOwnerReviewInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequiredApprovingReviewCountInput | double | *No description.* | +| RequiredReviewersInput | Io.Cdktn.IResolvable\|OrganizationRulesetRulesPullRequestRequiredReviewers[] | *No description.* | +| RequiredReviewThreadResolutionInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequireLastPushApprovalInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| AllowedMergeMethods | string[] | *No description.* | +| DismissStaleReviewsOnPush | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequireCodeOwnerReview | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequiredApprovingReviewCount | double | *No description.* | +| RequiredReviewThreadResolution | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequireLastPushApproval | bool\|Io.Cdktn.IResolvable | *No description.* | +| InternalValue | OrganizationRulesetRulesPullRequest | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `RequiredReviewers`Required + +```csharp +public OrganizationRulesetRulesPullRequestRequiredReviewersList RequiredReviewers { get; } +``` + +- *Type:* OrganizationRulesetRulesPullRequestRequiredReviewersList + +--- + +##### `AllowedMergeMethodsInput`Optional + +```csharp +public string[] AllowedMergeMethodsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `DismissStaleReviewsOnPushInput`Optional + +```csharp +public bool|IResolvable DismissStaleReviewsOnPushInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequireCodeOwnerReviewInput`Optional + +```csharp +public bool|IResolvable RequireCodeOwnerReviewInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequiredApprovingReviewCountInput`Optional + +```csharp +public double RequiredApprovingReviewCountInput { get; } +``` + +- *Type:* double + +--- + +##### `RequiredReviewersInput`Optional + +```csharp +public IResolvable|OrganizationRulesetRulesPullRequestRequiredReviewers[] RequiredReviewersInput { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetRulesPullRequestRequiredReviewers[] + +--- + +##### `RequiredReviewThreadResolutionInput`Optional + +```csharp +public bool|IResolvable RequiredReviewThreadResolutionInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequireLastPushApprovalInput`Optional + +```csharp +public bool|IResolvable RequireLastPushApprovalInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `AllowedMergeMethods`Required + +```csharp +public string[] AllowedMergeMethods { get; } +``` + +- *Type:* string[] + +--- + +##### `DismissStaleReviewsOnPush`Required + +```csharp +public bool|IResolvable DismissStaleReviewsOnPush { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequireCodeOwnerReview`Required + +```csharp +public bool|IResolvable RequireCodeOwnerReview { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequiredApprovingReviewCount`Required + +```csharp +public double RequiredApprovingReviewCount { get; } +``` + +- *Type:* double + +--- + +##### `RequiredReviewThreadResolution`Required + +```csharp +public bool|IResolvable RequiredReviewThreadResolution { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequireLastPushApproval`Required + +```csharp +public bool|IResolvable RequireLastPushApproval { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `InternalValue`Optional + +```csharp +public OrganizationRulesetRulesPullRequest InternalValue { get; } +``` + +- *Type:* OrganizationRulesetRulesPullRequest + +--- + + +### OrganizationRulesetRulesPullRequestRequiredReviewersList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesPullRequestRequiredReviewersList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private OrganizationRulesetRulesPullRequestRequiredReviewersOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|OrganizationRulesetRulesPullRequestRequiredReviewers[] | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|OrganizationRulesetRulesPullRequestRequiredReviewers[] InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetRulesPullRequestRequiredReviewers[] + +--- + + +### OrganizationRulesetRulesPullRequestRequiredReviewersOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesPullRequestRequiredReviewersOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| PutReviewer | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `PutReviewer` + +```csharp +private void PutReviewer(OrganizationRulesetRulesPullRequestRequiredReviewersReviewer Value) +``` + +###### `Value`Required + +- *Type:* OrganizationRulesetRulesPullRequestRequiredReviewersReviewer + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Reviewer | OrganizationRulesetRulesPullRequestRequiredReviewersReviewerOutputReference | *No description.* | +| FilePatternsInput | string[] | *No description.* | +| MinimumApprovalsInput | double | *No description.* | +| ReviewerInput | OrganizationRulesetRulesPullRequestRequiredReviewersReviewer | *No description.* | +| FilePatterns | string[] | *No description.* | +| MinimumApprovals | double | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|OrganizationRulesetRulesPullRequestRequiredReviewers | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Reviewer`Required + +```csharp +public OrganizationRulesetRulesPullRequestRequiredReviewersReviewerOutputReference Reviewer { get; } +``` + +- *Type:* OrganizationRulesetRulesPullRequestRequiredReviewersReviewerOutputReference + +--- + +##### `FilePatternsInput`Optional + +```csharp +public string[] FilePatternsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `MinimumApprovalsInput`Optional + +```csharp +public double MinimumApprovalsInput { get; } +``` + +- *Type:* double + +--- + +##### `ReviewerInput`Optional + +```csharp +public OrganizationRulesetRulesPullRequestRequiredReviewersReviewer ReviewerInput { get; } +``` + +- *Type:* OrganizationRulesetRulesPullRequestRequiredReviewersReviewer + +--- + +##### `FilePatterns`Required + +```csharp +public string[] FilePatterns { get; } +``` + +- *Type:* string[] + +--- + +##### `MinimumApprovals`Required + +```csharp +public double MinimumApprovals { get; } +``` + +- *Type:* double + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|OrganizationRulesetRulesPullRequestRequiredReviewers InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetRulesPullRequestRequiredReviewers + +--- + + +### OrganizationRulesetRulesPullRequestRequiredReviewersReviewerOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesPullRequestRequiredReviewersReviewerOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| IdInput | double | *No description.* | +| TypeInput | string | *No description.* | +| Id | double | *No description.* | +| Type | string | *No description.* | +| InternalValue | OrganizationRulesetRulesPullRequestRequiredReviewersReviewer | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public double IdInput { get; } +``` + +- *Type:* double + +--- + +##### `TypeInput`Optional + +```csharp +public string TypeInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public double Id { get; } +``` + +- *Type:* double + +--- + +##### `Type`Required + +```csharp +public string Type { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public OrganizationRulesetRulesPullRequestRequiredReviewersReviewer InternalValue { get; } +``` + +- *Type:* OrganizationRulesetRulesPullRequestRequiredReviewersReviewer + +--- + + +### OrganizationRulesetRulesRequiredCodeScanningOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesRequiredCodeScanningOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| PutRequiredCodeScanningTool | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `PutRequiredCodeScanningTool` + +```csharp +private void PutRequiredCodeScanningTool(IResolvable|OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] Value) +``` + +###### `Value`Required + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| RequiredCodeScanningTool | OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningToolList | *No description.* | +| RequiredCodeScanningToolInput | Io.Cdktn.IResolvable\|OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] | *No description.* | +| InternalValue | OrganizationRulesetRulesRequiredCodeScanning | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `RequiredCodeScanningTool`Required + +```csharp +public OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningToolList RequiredCodeScanningTool { get; } +``` + +- *Type:* OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningToolList + +--- + +##### `RequiredCodeScanningToolInput`Optional + +```csharp +public IResolvable|OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] RequiredCodeScanningToolInput { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] + +--- + +##### `InternalValue`Optional + +```csharp +public OrganizationRulesetRulesRequiredCodeScanning InternalValue { get; } +``` + +- *Type:* OrganizationRulesetRulesRequiredCodeScanning + +--- + + +### OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningToolList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningToolList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningToolOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] + +--- + + +### OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningToolOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningToolOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| AlertsThresholdInput | string | *No description.* | +| SecurityAlertsThresholdInput | string | *No description.* | +| ToolInput | string | *No description.* | +| AlertsThreshold | string | *No description.* | +| SecurityAlertsThreshold | string | *No description.* | +| Tool | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `AlertsThresholdInput`Optional + +```csharp +public string AlertsThresholdInput { get; } +``` + +- *Type:* string + +--- + +##### `SecurityAlertsThresholdInput`Optional + +```csharp +public string SecurityAlertsThresholdInput { get; } +``` + +- *Type:* string + +--- + +##### `ToolInput`Optional + +```csharp +public string ToolInput { get; } +``` + +- *Type:* string + +--- + +##### `AlertsThreshold`Required + +```csharp +public string AlertsThreshold { get; } +``` + +- *Type:* string + +--- + +##### `SecurityAlertsThreshold`Required + +```csharp +public string SecurityAlertsThreshold { get; } +``` + +- *Type:* string + +--- + +##### `Tool`Required + +```csharp +public string Tool { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool + +--- + + +### OrganizationRulesetRulesRequiredStatusChecksOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesRequiredStatusChecksOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| PutRequiredCheck | *No description.* | +| ResetDoNotEnforceOnCreate | *No description.* | +| ResetStrictRequiredStatusChecksPolicy | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `PutRequiredCheck` + +```csharp +private void PutRequiredCheck(IResolvable|OrganizationRulesetRulesRequiredStatusChecksRequiredCheck[] Value) +``` + +###### `Value`Required + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetRulesRequiredStatusChecksRequiredCheck[] + +--- + +##### `ResetDoNotEnforceOnCreate` + +```csharp +private void ResetDoNotEnforceOnCreate() +``` + +##### `ResetStrictRequiredStatusChecksPolicy` + +```csharp +private void ResetStrictRequiredStatusChecksPolicy() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| RequiredCheck | OrganizationRulesetRulesRequiredStatusChecksRequiredCheckList | *No description.* | +| DoNotEnforceOnCreateInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequiredCheckInput | Io.Cdktn.IResolvable\|OrganizationRulesetRulesRequiredStatusChecksRequiredCheck[] | *No description.* | +| StrictRequiredStatusChecksPolicyInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| DoNotEnforceOnCreate | bool\|Io.Cdktn.IResolvable | *No description.* | +| StrictRequiredStatusChecksPolicy | bool\|Io.Cdktn.IResolvable | *No description.* | +| InternalValue | OrganizationRulesetRulesRequiredStatusChecks | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `RequiredCheck`Required + +```csharp +public OrganizationRulesetRulesRequiredStatusChecksRequiredCheckList RequiredCheck { get; } +``` + +- *Type:* OrganizationRulesetRulesRequiredStatusChecksRequiredCheckList + +--- + +##### `DoNotEnforceOnCreateInput`Optional + +```csharp +public bool|IResolvable DoNotEnforceOnCreateInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequiredCheckInput`Optional + +```csharp +public IResolvable|OrganizationRulesetRulesRequiredStatusChecksRequiredCheck[] RequiredCheckInput { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetRulesRequiredStatusChecksRequiredCheck[] + +--- + +##### `StrictRequiredStatusChecksPolicyInput`Optional + +```csharp +public bool|IResolvable StrictRequiredStatusChecksPolicyInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `DoNotEnforceOnCreate`Required + +```csharp +public bool|IResolvable DoNotEnforceOnCreate { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `StrictRequiredStatusChecksPolicy`Required + +```csharp +public bool|IResolvable StrictRequiredStatusChecksPolicy { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `InternalValue`Optional + +```csharp +public OrganizationRulesetRulesRequiredStatusChecks InternalValue { get; } +``` + +- *Type:* OrganizationRulesetRulesRequiredStatusChecks + +--- + + +### OrganizationRulesetRulesRequiredStatusChecksRequiredCheckList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesRequiredStatusChecksRequiredCheckList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private OrganizationRulesetRulesRequiredStatusChecksRequiredCheckOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|OrganizationRulesetRulesRequiredStatusChecksRequiredCheck[] | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|OrganizationRulesetRulesRequiredStatusChecksRequiredCheck[] InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetRulesRequiredStatusChecksRequiredCheck[] + +--- + + +### OrganizationRulesetRulesRequiredStatusChecksRequiredCheckOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesRequiredStatusChecksRequiredCheckOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetIntegrationId | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetIntegrationId` + +```csharp +private void ResetIntegrationId() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| ContextInput | string | *No description.* | +| IntegrationIdInput | double | *No description.* | +| Context | string | *No description.* | +| IntegrationId | double | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|OrganizationRulesetRulesRequiredStatusChecksRequiredCheck | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `ContextInput`Optional + +```csharp +public string ContextInput { get; } +``` + +- *Type:* string + +--- + +##### `IntegrationIdInput`Optional + +```csharp +public double IntegrationIdInput { get; } +``` + +- *Type:* double + +--- + +##### `Context`Required + +```csharp +public string Context { get; } +``` + +- *Type:* string + +--- + +##### `IntegrationId`Required + +```csharp +public double IntegrationId { get; } +``` + +- *Type:* double + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|OrganizationRulesetRulesRequiredStatusChecksRequiredCheck InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetRulesRequiredStatusChecksRequiredCheck + +--- + + +### OrganizationRulesetRulesRequiredWorkflowsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesRequiredWorkflowsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| PutRequiredWorkflow | *No description.* | +| ResetDoNotEnforceOnCreate | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `PutRequiredWorkflow` + +```csharp +private void PutRequiredWorkflow(IResolvable|OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow[] Value) +``` + +###### `Value`Required + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow[] + +--- + +##### `ResetDoNotEnforceOnCreate` + +```csharp +private void ResetDoNotEnforceOnCreate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| RequiredWorkflow | OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflowList | *No description.* | +| DoNotEnforceOnCreateInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequiredWorkflowInput | Io.Cdktn.IResolvable\|OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow[] | *No description.* | +| DoNotEnforceOnCreate | bool\|Io.Cdktn.IResolvable | *No description.* | +| InternalValue | OrganizationRulesetRulesRequiredWorkflows | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `RequiredWorkflow`Required + +```csharp +public OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflowList RequiredWorkflow { get; } +``` + +- *Type:* OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflowList + +--- + +##### `DoNotEnforceOnCreateInput`Optional + +```csharp +public bool|IResolvable DoNotEnforceOnCreateInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequiredWorkflowInput`Optional + +```csharp +public IResolvable|OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow[] RequiredWorkflowInput { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow[] + +--- + +##### `DoNotEnforceOnCreate`Required + +```csharp +public bool|IResolvable DoNotEnforceOnCreate { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `InternalValue`Optional + +```csharp +public OrganizationRulesetRulesRequiredWorkflows InternalValue { get; } +``` + +- *Type:* OrganizationRulesetRulesRequiredWorkflows + +--- + + +### OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflowList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflowList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflowOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow[] | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow[] InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow[] + +--- + + +### OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflowOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflowOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetRef | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetRef` + +```csharp +private void ResetRef() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| PathInput | string | *No description.* | +| RefInput | string | *No description.* | +| RepositoryIdInput | double | *No description.* | +| Path | string | *No description.* | +| Ref | string | *No description.* | +| RepositoryId | double | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `PathInput`Optional + +```csharp +public string PathInput { get; } +``` + +- *Type:* string + +--- + +##### `RefInput`Optional + +```csharp +public string RefInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryIdInput`Optional + +```csharp +public double RepositoryIdInput { get; } +``` + +- *Type:* double + +--- + +##### `Path`Required + +```csharp +public string Path { get; } +``` + +- *Type:* string + +--- + +##### `Ref`Required + +```csharp +public string Ref { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryId`Required + +```csharp +public double RepositoryId { get; } +``` + +- *Type:* double + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow + +--- + + +### OrganizationRulesetRulesTagNamePatternOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationRulesetRulesTagNamePatternOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetName | *No description.* | +| ResetNegate | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetName` + +```csharp +private void ResetName() +``` + +##### `ResetNegate` + +```csharp +private void ResetNegate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| NameInput | string | *No description.* | +| NegateInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| OperatorInput | string | *No description.* | +| PatternInput | string | *No description.* | +| Name | string | *No description.* | +| Negate | bool\|Io.Cdktn.IResolvable | *No description.* | +| Operator | string | *No description.* | +| Pattern | string | *No description.* | +| InternalValue | OrganizationRulesetRulesTagNamePattern | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `NegateInput`Optional + +```csharp +public bool|IResolvable NegateInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `OperatorInput`Optional + +```csharp +public string OperatorInput { get; } +``` + +- *Type:* string + +--- + +##### `PatternInput`Optional + +```csharp +public string PatternInput { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Negate`Required + +```csharp +public bool|IResolvable Negate { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Operator`Required + +```csharp +public string Operator { get; } +``` + +- *Type:* string + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public OrganizationRulesetRulesTagNamePattern InternalValue { get; } +``` + +- *Type:* OrganizationRulesetRulesTagNamePattern + +--- + + + diff --git a/docs/organizationRuleset.java.md b/docs/organizationRuleset.java.md new file mode 100644 index 000000000..800df4468 --- /dev/null +++ b/docs/organizationRuleset.java.md @@ -0,0 +1,13968 @@ +# `organizationRuleset` Submodule + +## Constructs + +### OrganizationRuleset + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset github_organization_ruleset}. + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRuleset; + +OrganizationRuleset.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .enforcement(java.lang.String) + .name(java.lang.String) + .rules(OrganizationRulesetRules) + .target(java.lang.String) +// .bypassActors(IResolvable|java.util.List) +// .conditions(OrganizationRulesetConditions) +// .id(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 | *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 | *No description.* | +| enforcement | java.lang.String | The enforcement level of the ruleset. | +| name | java.lang.String | The name of the ruleset. | +| rules | OrganizationRulesetRules | rules block. | +| target | java.lang.String | The target of the ruleset. Possible values are branch, tag and push. | +| bypassActors | io.cdktn.cdktn.IResolvable\|java.util.List<OrganizationRulesetBypassActors> | bypass_actors block. | +| conditions | OrganizationRulesetConditions | conditions block. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#id OrganizationRuleset#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `enforcement`Required + +- *Type:* java.lang.String + +The enforcement level of the ruleset. + +`evaluate` allows admins to test rules before enforcing them. Possible values are `disabled`, `active`, and `evaluate`. Note: `evaluate` is only available for Enterprise plans. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#enforcement OrganizationRuleset#enforcement} + +--- + +##### `name`Required + +- *Type:* java.lang.String + +The name of the ruleset. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#name OrganizationRuleset#name} + +--- + +##### `rules`Required + +- *Type:* OrganizationRulesetRules + +rules block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#rules OrganizationRuleset#rules} + +--- + +##### `target`Required + +- *Type:* java.lang.String + +The target of the ruleset. Possible values are branch, tag and push. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#target OrganizationRuleset#target} + +--- + +##### `bypassActors`Optional + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetBypassActors> + +bypass_actors block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#bypass_actors OrganizationRuleset#bypass_actors} + +--- + +##### `conditions`Optional + +- *Type:* OrganizationRulesetConditions + +conditions block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#conditions OrganizationRuleset#conditions} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#id OrganizationRuleset#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| putBypassActors | *No description.* | +| putConditions | *No description.* | +| putRules | *No description.* | +| resetBypassActors | *No description.* | +| resetConditions | *No description.* | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `putBypassActors` + +```java +public void putBypassActors(IResolvable|java.util.List value) +``` + +###### `value`Required + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetBypassActors> + +--- + +##### `putConditions` + +```java +public void putConditions(OrganizationRulesetConditions value) +``` + +###### `value`Required + +- *Type:* OrganizationRulesetConditions + +--- + +##### `putRules` + +```java +public void putRules(OrganizationRulesetRules value) +``` + +###### `value`Required + +- *Type:* OrganizationRulesetRules + +--- + +##### `resetBypassActors` + +```java +public void resetBypassActors() +``` + +##### `resetConditions` + +```java +public void resetConditions() +``` + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a OrganizationRuleset resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRuleset; + +OrganizationRuleset.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` + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRuleset; + +OrganizationRuleset.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRuleset; + +OrganizationRuleset.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRuleset; + +OrganizationRuleset.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),OrganizationRuleset.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a OrganizationRuleset 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 OrganizationRuleset to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing OrganizationRuleset that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#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 OrganizationRuleset 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| bypassActors | OrganizationRulesetBypassActorsList | *No description.* | +| conditions | OrganizationRulesetConditionsOutputReference | *No description.* | +| etag | java.lang.String | *No description.* | +| nodeId | java.lang.String | *No description.* | +| rules | OrganizationRulesetRulesOutputReference | *No description.* | +| rulesetId | java.lang.Number | *No description.* | +| bypassActorsInput | io.cdktn.cdktn.IResolvable\|java.util.List<OrganizationRulesetBypassActors> | *No description.* | +| conditionsInput | OrganizationRulesetConditions | *No description.* | +| enforcementInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| rulesInput | OrganizationRulesetRules | *No description.* | +| targetInput | java.lang.String | *No description.* | +| enforcement | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| target | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `bypassActors`Required + +```java +public OrganizationRulesetBypassActorsList getBypassActors(); +``` + +- *Type:* OrganizationRulesetBypassActorsList + +--- + +##### `conditions`Required + +```java +public OrganizationRulesetConditionsOutputReference getConditions(); +``` + +- *Type:* OrganizationRulesetConditionsOutputReference + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `nodeId`Required + +```java +public java.lang.String getNodeId(); +``` + +- *Type:* java.lang.String + +--- + +##### `rules`Required + +```java +public OrganizationRulesetRulesOutputReference getRules(); +``` + +- *Type:* OrganizationRulesetRulesOutputReference + +--- + +##### `rulesetId`Required + +```java +public java.lang.Number getRulesetId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `bypassActorsInput`Optional + +```java +public IResolvable|java.util.List getBypassActorsInput(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetBypassActors> + +--- + +##### `conditionsInput`Optional + +```java +public OrganizationRulesetConditions getConditionsInput(); +``` + +- *Type:* OrganizationRulesetConditions + +--- + +##### `enforcementInput`Optional + +```java +public java.lang.String getEnforcementInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `rulesInput`Optional + +```java +public OrganizationRulesetRules getRulesInput(); +``` + +- *Type:* OrganizationRulesetRules + +--- + +##### `targetInput`Optional + +```java +public java.lang.String getTargetInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `enforcement`Required + +```java +public java.lang.String getEnforcement(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `target`Required + +```java +public java.lang.String getTarget(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### OrganizationRulesetBypassActors + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetBypassActors; + +OrganizationRulesetBypassActors.builder() + .actorType(java.lang.String) + .bypassMode(java.lang.String) +// .actorId(java.lang.Number) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| actorType | java.lang.String | The type of actor that can bypass a ruleset. Can be one of: `Integration`, `OrganizationAdmin`, `RepositoryRole`, `Team`, or `DeployKey`. | +| bypassMode | java.lang.String | When the specified actor can bypass the ruleset. | +| actorId | java.lang.Number | The ID of the actor that can bypass a ruleset. | + +--- + +##### `actorType`Required + +```java +public java.lang.String getActorType(); +``` + +- *Type:* java.lang.String + +The type of actor that can bypass a ruleset. Can be one of: `Integration`, `OrganizationAdmin`, `RepositoryRole`, `Team`, or `DeployKey`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#actor_type OrganizationRuleset#actor_type} + +--- + +##### `bypassMode`Required + +```java +public java.lang.String getBypassMode(); +``` + +- *Type:* java.lang.String + +When the specified actor can bypass the ruleset. + +pull_request means that an actor can only bypass rules on pull requests. Can be one of: `always`, `pull_request`, `exempt`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#bypass_mode OrganizationRuleset#bypass_mode} + +--- + +##### `actorId`Optional + +```java +public java.lang.Number getActorId(); +``` + +- *Type:* java.lang.Number + +The ID of the actor that can bypass a ruleset. + +When `actor_type` is `OrganizationAdmin`, this should be set to `1`. Some resources such as DeployKey do not have an ID and this should be omitted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#actor_id OrganizationRuleset#actor_id} + +--- + +### OrganizationRulesetConditions + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetConditions; + +OrganizationRulesetConditions.builder() +// .refName(OrganizationRulesetConditionsRefName) +// .repositoryId(java.util.List) +// .repositoryName(OrganizationRulesetConditionsRepositoryName) +// .repositoryProperty(OrganizationRulesetConditionsRepositoryProperty) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| refName | OrganizationRulesetConditionsRefName | ref_name block. | +| repositoryId | java.util.List | The repository IDs that the ruleset applies to. One of these IDs must match for the ruleset to apply. | +| repositoryName | OrganizationRulesetConditionsRepositoryName | repository_name block. | +| repositoryProperty | OrganizationRulesetConditionsRepositoryProperty | repository_property block. | + +--- + +##### `refName`Optional + +```java +public OrganizationRulesetConditionsRefName getRefName(); +``` + +- *Type:* OrganizationRulesetConditionsRefName + +ref_name block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#ref_name OrganizationRuleset#ref_name} + +--- + +##### `repositoryId`Optional + +```java +public java.util.List getRepositoryId(); +``` + +- *Type:* java.util.List + +The repository IDs that the ruleset applies to. One of these IDs must match for the ruleset to apply. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#repository_id OrganizationRuleset#repository_id} + +--- + +##### `repositoryName`Optional + +```java +public OrganizationRulesetConditionsRepositoryName getRepositoryName(); +``` + +- *Type:* OrganizationRulesetConditionsRepositoryName + +repository_name block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#repository_name OrganizationRuleset#repository_name} + +--- + +##### `repositoryProperty`Optional + +```java +public OrganizationRulesetConditionsRepositoryProperty getRepositoryProperty(); +``` + +- *Type:* OrganizationRulesetConditionsRepositoryProperty + +repository_property block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#repository_property OrganizationRuleset#repository_property} + +--- + +### OrganizationRulesetConditionsRefName + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetConditionsRefName; + +OrganizationRulesetConditionsRefName.builder() + .exclude(java.util.List) + .include(java.util.List) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| exclude | java.util.List | Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. | +| include | java.util.List | Array of ref names or patterns to include. | + +--- + +##### `exclude`Required + +```java +public java.util.List getExclude(); +``` + +- *Type:* java.util.List + +Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#exclude OrganizationRuleset#exclude} + +--- + +##### `include`Required + +```java +public java.util.List getInclude(); +``` + +- *Type:* java.util.List + +Array of ref names or patterns to include. + +One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#include OrganizationRuleset#include} + +--- + +### OrganizationRulesetConditionsRepositoryName + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetConditionsRepositoryName; + +OrganizationRulesetConditionsRepositoryName.builder() + .exclude(java.util.List) + .include(java.util.List) +// .protected(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| exclude | java.util.List | Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. | +| include | java.util.List | Array of repository names or patterns to include. | +| protected | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether renaming of target repositories is prevented. | + +--- + +##### `exclude`Required + +```java +public java.util.List getExclude(); +``` + +- *Type:* java.util.List + +Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#exclude OrganizationRuleset#exclude} + +--- + +##### `include`Required + +```java +public java.util.List getInclude(); +``` + +- *Type:* java.util.List + +Array of repository names or patterns to include. + +One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#include OrganizationRuleset#include} + +--- + +##### `protected`Optional + +```java +public java.lang.Boolean|IResolvable getProtected(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether renaming of target repositories is prevented. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#protected OrganizationRuleset#protected} + +--- + +### OrganizationRulesetConditionsRepositoryProperty + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetConditionsRepositoryProperty; + +OrganizationRulesetConditionsRepositoryProperty.builder() +// .exclude(IResolvable|java.util.List) +// .include(IResolvable|java.util.List) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| exclude | io.cdktn.cdktn.IResolvable\|java.util.List<OrganizationRulesetConditionsRepositoryPropertyExclude> | The repository properties and values to exclude. The ruleset will not apply if any of these properties match. | +| include | io.cdktn.cdktn.IResolvable\|java.util.List<OrganizationRulesetConditionsRepositoryPropertyInclude> | The repository properties and values to include. All of these properties must match for the condition to pass. | + +--- + +##### `exclude`Optional + +```java +public IResolvable|java.util.List getExclude(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetConditionsRepositoryPropertyExclude> + +The repository properties and values to exclude. The ruleset will not apply if any of these properties match. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#exclude OrganizationRuleset#exclude} + +--- + +##### `include`Optional + +```java +public IResolvable|java.util.List getInclude(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetConditionsRepositoryPropertyInclude> + +The repository properties and values to include. All of these properties must match for the condition to pass. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#include OrganizationRuleset#include} + +--- + +### OrganizationRulesetConditionsRepositoryPropertyExclude + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetConditionsRepositoryPropertyExclude; + +OrganizationRulesetConditionsRepositoryPropertyExclude.builder() +// .name(java.lang.String) +// .propertyValues(java.util.List) +// .source(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#name OrganizationRuleset#name}. | +| propertyValues | java.util.List | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#property_values OrganizationRuleset#property_values}. | +| source | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#source OrganizationRuleset#source}. | + +--- + +##### `name`Optional + +```java +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/resources/organization_ruleset#name OrganizationRuleset#name}. + +--- + +##### `propertyValues`Optional + +```java +public java.util.List getPropertyValues(); +``` + +- *Type:* java.util.List + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#property_values OrganizationRuleset#property_values}. + +--- + +##### `source`Optional + +```java +public java.lang.String getSource(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#source OrganizationRuleset#source}. + +--- + +### OrganizationRulesetConditionsRepositoryPropertyInclude + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetConditionsRepositoryPropertyInclude; + +OrganizationRulesetConditionsRepositoryPropertyInclude.builder() +// .name(java.lang.String) +// .propertyValues(java.util.List) +// .source(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#name OrganizationRuleset#name}. | +| propertyValues | java.util.List | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#property_values OrganizationRuleset#property_values}. | +| source | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#source OrganizationRuleset#source}. | + +--- + +##### `name`Optional + +```java +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/resources/organization_ruleset#name OrganizationRuleset#name}. + +--- + +##### `propertyValues`Optional + +```java +public java.util.List getPropertyValues(); +``` + +- *Type:* java.util.List + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#property_values OrganizationRuleset#property_values}. + +--- + +##### `source`Optional + +```java +public java.lang.String getSource(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#source OrganizationRuleset#source}. + +--- + +### OrganizationRulesetConfig + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetConfig; + +OrganizationRulesetConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .enforcement(java.lang.String) + .name(java.lang.String) + .rules(OrganizationRulesetRules) + .target(java.lang.String) +// .bypassActors(IResolvable|java.util.List) +// .conditions(OrganizationRulesetConditions) +// .id(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 | *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 | *No description.* | +| enforcement | java.lang.String | The enforcement level of the ruleset. | +| name | java.lang.String | The name of the ruleset. | +| rules | OrganizationRulesetRules | rules block. | +| target | java.lang.String | The target of the ruleset. Possible values are branch, tag and push. | +| bypassActors | io.cdktn.cdktn.IResolvable\|java.util.List<OrganizationRulesetBypassActors> | bypass_actors block. | +| conditions | OrganizationRulesetConditions | conditions block. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#id OrganizationRuleset#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `enforcement`Required + +```java +public java.lang.String getEnforcement(); +``` + +- *Type:* java.lang.String + +The enforcement level of the ruleset. + +`evaluate` allows admins to test rules before enforcing them. Possible values are `disabled`, `active`, and `evaluate`. Note: `evaluate` is only available for Enterprise plans. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#enforcement OrganizationRuleset#enforcement} + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +The name of the ruleset. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#name OrganizationRuleset#name} + +--- + +##### `rules`Required + +```java +public OrganizationRulesetRules getRules(); +``` + +- *Type:* OrganizationRulesetRules + +rules block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#rules OrganizationRuleset#rules} + +--- + +##### `target`Required + +```java +public java.lang.String getTarget(); +``` + +- *Type:* java.lang.String + +The target of the ruleset. Possible values are branch, tag and push. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#target OrganizationRuleset#target} + +--- + +##### `bypassActors`Optional + +```java +public IResolvable|java.util.List getBypassActors(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetBypassActors> + +bypass_actors block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#bypass_actors OrganizationRuleset#bypass_actors} + +--- + +##### `conditions`Optional + +```java +public OrganizationRulesetConditions getConditions(); +``` + +- *Type:* OrganizationRulesetConditions + +conditions block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#conditions OrganizationRuleset#conditions} + +--- + +##### `id`Optional + +```java +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/resources/organization_ruleset#id OrganizationRuleset#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. + +--- + +### OrganizationRulesetRules + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRules; + +OrganizationRulesetRules.builder() +// .branchNamePattern(OrganizationRulesetRulesBranchNamePattern) +// .commitAuthorEmailPattern(OrganizationRulesetRulesCommitAuthorEmailPattern) +// .commitMessagePattern(OrganizationRulesetRulesCommitMessagePattern) +// .committerEmailPattern(OrganizationRulesetRulesCommitterEmailPattern) +// .copilotCodeReview(OrganizationRulesetRulesCopilotCodeReview) +// .creation(java.lang.Boolean|IResolvable) +// .deletion(java.lang.Boolean|IResolvable) +// .fileExtensionRestriction(OrganizationRulesetRulesFileExtensionRestriction) +// .filePathRestriction(OrganizationRulesetRulesFilePathRestriction) +// .maxFilePathLength(OrganizationRulesetRulesMaxFilePathLength) +// .maxFileSize(OrganizationRulesetRulesMaxFileSize) +// .nonFastForward(java.lang.Boolean|IResolvable) +// .pullRequest(OrganizationRulesetRulesPullRequest) +// .requiredCodeScanning(OrganizationRulesetRulesRequiredCodeScanning) +// .requiredLinearHistory(java.lang.Boolean|IResolvable) +// .requiredSignatures(java.lang.Boolean|IResolvable) +// .requiredStatusChecks(OrganizationRulesetRulesRequiredStatusChecks) +// .requiredWorkflows(OrganizationRulesetRulesRequiredWorkflows) +// .tagNamePattern(OrganizationRulesetRulesTagNamePattern) +// .update(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| branchNamePattern | OrganizationRulesetRulesBranchNamePattern | branch_name_pattern block. | +| commitAuthorEmailPattern | OrganizationRulesetRulesCommitAuthorEmailPattern | commit_author_email_pattern block. | +| commitMessagePattern | OrganizationRulesetRulesCommitMessagePattern | commit_message_pattern block. | +| committerEmailPattern | OrganizationRulesetRulesCommitterEmailPattern | committer_email_pattern block. | +| copilotCodeReview | OrganizationRulesetRulesCopilotCodeReview | copilot_code_review block. | +| creation | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Only allow users with bypass permission to create matching refs. | +| deletion | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Only allow users with bypass permissions to delete matching refs. | +| fileExtensionRestriction | OrganizationRulesetRulesFileExtensionRestriction | file_extension_restriction block. | +| filePathRestriction | OrganizationRulesetRulesFilePathRestriction | file_path_restriction block. | +| maxFilePathLength | OrganizationRulesetRulesMaxFilePathLength | max_file_path_length block. | +| maxFileSize | OrganizationRulesetRulesMaxFileSize | max_file_size block. | +| nonFastForward | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Prevent users with push access from force pushing to refs. | +| pullRequest | OrganizationRulesetRulesPullRequest | pull_request block. | +| requiredCodeScanning | OrganizationRulesetRulesRequiredCodeScanning | required_code_scanning block. | +| requiredLinearHistory | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Prevent merge commits from being pushed to matching branches. | +| requiredSignatures | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Commits pushed to matching branches must have verified signatures. | +| requiredStatusChecks | OrganizationRulesetRulesRequiredStatusChecks | required_status_checks block. | +| requiredWorkflows | OrganizationRulesetRulesRequiredWorkflows | required_workflows block. | +| tagNamePattern | OrganizationRulesetRulesTagNamePattern | tag_name_pattern block. | +| update | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Only allow users with bypass permission to update matching refs. | + +--- + +##### `branchNamePattern`Optional + +```java +public OrganizationRulesetRulesBranchNamePattern getBranchNamePattern(); +``` + +- *Type:* OrganizationRulesetRulesBranchNamePattern + +branch_name_pattern block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#branch_name_pattern OrganizationRuleset#branch_name_pattern} + +--- + +##### `commitAuthorEmailPattern`Optional + +```java +public OrganizationRulesetRulesCommitAuthorEmailPattern getCommitAuthorEmailPattern(); +``` + +- *Type:* OrganizationRulesetRulesCommitAuthorEmailPattern + +commit_author_email_pattern block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#commit_author_email_pattern OrganizationRuleset#commit_author_email_pattern} + +--- + +##### `commitMessagePattern`Optional + +```java +public OrganizationRulesetRulesCommitMessagePattern getCommitMessagePattern(); +``` + +- *Type:* OrganizationRulesetRulesCommitMessagePattern + +commit_message_pattern block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#commit_message_pattern OrganizationRuleset#commit_message_pattern} + +--- + +##### `committerEmailPattern`Optional + +```java +public OrganizationRulesetRulesCommitterEmailPattern getCommitterEmailPattern(); +``` + +- *Type:* OrganizationRulesetRulesCommitterEmailPattern + +committer_email_pattern block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#committer_email_pattern OrganizationRuleset#committer_email_pattern} + +--- + +##### `copilotCodeReview`Optional + +```java +public OrganizationRulesetRulesCopilotCodeReview getCopilotCodeReview(); +``` + +- *Type:* OrganizationRulesetRulesCopilotCodeReview + +copilot_code_review block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#copilot_code_review OrganizationRuleset#copilot_code_review} + +--- + +##### `creation`Optional + +```java +public java.lang.Boolean|IResolvable getCreation(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Only allow users with bypass permission to create matching refs. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#creation OrganizationRuleset#creation} + +--- + +##### `deletion`Optional + +```java +public java.lang.Boolean|IResolvable getDeletion(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Only allow users with bypass permissions to delete matching refs. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#deletion OrganizationRuleset#deletion} + +--- + +##### `fileExtensionRestriction`Optional + +```java +public OrganizationRulesetRulesFileExtensionRestriction getFileExtensionRestriction(); +``` + +- *Type:* OrganizationRulesetRulesFileExtensionRestriction + +file_extension_restriction block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#file_extension_restriction OrganizationRuleset#file_extension_restriction} + +--- + +##### `filePathRestriction`Optional + +```java +public OrganizationRulesetRulesFilePathRestriction getFilePathRestriction(); +``` + +- *Type:* OrganizationRulesetRulesFilePathRestriction + +file_path_restriction block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#file_path_restriction OrganizationRuleset#file_path_restriction} + +--- + +##### `maxFilePathLength`Optional + +```java +public OrganizationRulesetRulesMaxFilePathLength getMaxFilePathLength(); +``` + +- *Type:* OrganizationRulesetRulesMaxFilePathLength + +max_file_path_length block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#max_file_path_length OrganizationRuleset#max_file_path_length} + +--- + +##### `maxFileSize`Optional + +```java +public OrganizationRulesetRulesMaxFileSize getMaxFileSize(); +``` + +- *Type:* OrganizationRulesetRulesMaxFileSize + +max_file_size block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#max_file_size OrganizationRuleset#max_file_size} + +--- + +##### `nonFastForward`Optional + +```java +public java.lang.Boolean|IResolvable getNonFastForward(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Prevent users with push access from force pushing to refs. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#non_fast_forward OrganizationRuleset#non_fast_forward} + +--- + +##### `pullRequest`Optional + +```java +public OrganizationRulesetRulesPullRequest getPullRequest(); +``` + +- *Type:* OrganizationRulesetRulesPullRequest + +pull_request block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#pull_request OrganizationRuleset#pull_request} + +--- + +##### `requiredCodeScanning`Optional + +```java +public OrganizationRulesetRulesRequiredCodeScanning getRequiredCodeScanning(); +``` + +- *Type:* OrganizationRulesetRulesRequiredCodeScanning + +required_code_scanning block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#required_code_scanning OrganizationRuleset#required_code_scanning} + +--- + +##### `requiredLinearHistory`Optional + +```java +public java.lang.Boolean|IResolvable getRequiredLinearHistory(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Prevent merge commits from being pushed to matching branches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#required_linear_history OrganizationRuleset#required_linear_history} + +--- + +##### `requiredSignatures`Optional + +```java +public java.lang.Boolean|IResolvable getRequiredSignatures(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Commits pushed to matching branches must have verified signatures. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#required_signatures OrganizationRuleset#required_signatures} + +--- + +##### `requiredStatusChecks`Optional + +```java +public OrganizationRulesetRulesRequiredStatusChecks getRequiredStatusChecks(); +``` + +- *Type:* OrganizationRulesetRulesRequiredStatusChecks + +required_status_checks block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#required_status_checks OrganizationRuleset#required_status_checks} + +--- + +##### `requiredWorkflows`Optional + +```java +public OrganizationRulesetRulesRequiredWorkflows getRequiredWorkflows(); +``` + +- *Type:* OrganizationRulesetRulesRequiredWorkflows + +required_workflows block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#required_workflows OrganizationRuleset#required_workflows} + +--- + +##### `tagNamePattern`Optional + +```java +public OrganizationRulesetRulesTagNamePattern getTagNamePattern(); +``` + +- *Type:* OrganizationRulesetRulesTagNamePattern + +tag_name_pattern block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#tag_name_pattern OrganizationRuleset#tag_name_pattern} + +--- + +##### `update`Optional + +```java +public java.lang.Boolean|IResolvable getUpdate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Only allow users with bypass permission to update matching refs. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#update OrganizationRuleset#update} + +--- + +### OrganizationRulesetRulesBranchNamePattern + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesBranchNamePattern; + +OrganizationRulesetRulesBranchNamePattern.builder() + .operator(java.lang.String) + .pattern(java.lang.String) +// .name(java.lang.String) +// .negate(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| operator | java.lang.String | The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. | +| pattern | java.lang.String | The pattern to match with. | +| name | java.lang.String | How this rule will appear to users. | +| negate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | If true, the rule will fail if the pattern matches. | + +--- + +##### `operator`Required + +```java +public java.lang.String getOperator(); +``` + +- *Type:* java.lang.String + +The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#operator OrganizationRuleset#operator} + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +The pattern to match with. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#pattern OrganizationRuleset#pattern} + +--- + +##### `name`Optional + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +How this rule will appear to users. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#name OrganizationRuleset#name} + +--- + +##### `negate`Optional + +```java +public java.lang.Boolean|IResolvable getNegate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +If true, the rule will fail if the pattern matches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#negate OrganizationRuleset#negate} + +--- + +### OrganizationRulesetRulesCommitAuthorEmailPattern + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesCommitAuthorEmailPattern; + +OrganizationRulesetRulesCommitAuthorEmailPattern.builder() + .operator(java.lang.String) + .pattern(java.lang.String) +// .name(java.lang.String) +// .negate(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| operator | java.lang.String | The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. | +| pattern | java.lang.String | The pattern to match with. | +| name | java.lang.String | How this rule will appear to users. | +| negate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | If true, the rule will fail if the pattern matches. | + +--- + +##### `operator`Required + +```java +public java.lang.String getOperator(); +``` + +- *Type:* java.lang.String + +The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#operator OrganizationRuleset#operator} + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +The pattern to match with. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#pattern OrganizationRuleset#pattern} + +--- + +##### `name`Optional + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +How this rule will appear to users. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#name OrganizationRuleset#name} + +--- + +##### `negate`Optional + +```java +public java.lang.Boolean|IResolvable getNegate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +If true, the rule will fail if the pattern matches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#negate OrganizationRuleset#negate} + +--- + +### OrganizationRulesetRulesCommitMessagePattern + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesCommitMessagePattern; + +OrganizationRulesetRulesCommitMessagePattern.builder() + .operator(java.lang.String) + .pattern(java.lang.String) +// .name(java.lang.String) +// .negate(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| operator | java.lang.String | The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. | +| pattern | java.lang.String | The pattern to match with. | +| name | java.lang.String | How this rule will appear to users. | +| negate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | If true, the rule will fail if the pattern matches. | + +--- + +##### `operator`Required + +```java +public java.lang.String getOperator(); +``` + +- *Type:* java.lang.String + +The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#operator OrganizationRuleset#operator} + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +The pattern to match with. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#pattern OrganizationRuleset#pattern} + +--- + +##### `name`Optional + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +How this rule will appear to users. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#name OrganizationRuleset#name} + +--- + +##### `negate`Optional + +```java +public java.lang.Boolean|IResolvable getNegate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +If true, the rule will fail if the pattern matches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#negate OrganizationRuleset#negate} + +--- + +### OrganizationRulesetRulesCommitterEmailPattern + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesCommitterEmailPattern; + +OrganizationRulesetRulesCommitterEmailPattern.builder() + .operator(java.lang.String) + .pattern(java.lang.String) +// .name(java.lang.String) +// .negate(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| operator | java.lang.String | The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. | +| pattern | java.lang.String | The pattern to match with. | +| name | java.lang.String | How this rule will appear to users. | +| negate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | If true, the rule will fail if the pattern matches. | + +--- + +##### `operator`Required + +```java +public java.lang.String getOperator(); +``` + +- *Type:* java.lang.String + +The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#operator OrganizationRuleset#operator} + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +The pattern to match with. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#pattern OrganizationRuleset#pattern} + +--- + +##### `name`Optional + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +How this rule will appear to users. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#name OrganizationRuleset#name} + +--- + +##### `negate`Optional + +```java +public java.lang.Boolean|IResolvable getNegate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +If true, the rule will fail if the pattern matches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#negate OrganizationRuleset#negate} + +--- + +### OrganizationRulesetRulesCopilotCodeReview + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesCopilotCodeReview; + +OrganizationRulesetRulesCopilotCodeReview.builder() +// .reviewDraftPullRequests(java.lang.Boolean|IResolvable) +// .reviewOnPush(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| reviewDraftPullRequests | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Copilot automatically reviews draft pull requests before they are marked as ready for review. Defaults to `false`. | +| reviewOnPush | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Copilot automatically reviews each new push to the pull request. Defaults to `false`. | + +--- + +##### `reviewDraftPullRequests`Optional + +```java +public java.lang.Boolean|IResolvable getReviewDraftPullRequests(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Copilot automatically reviews draft pull requests before they are marked as ready for review. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#review_draft_pull_requests OrganizationRuleset#review_draft_pull_requests} + +--- + +##### `reviewOnPush`Optional + +```java +public java.lang.Boolean|IResolvable getReviewOnPush(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Copilot automatically reviews each new push to the pull request. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#review_on_push OrganizationRuleset#review_on_push} + +--- + +### OrganizationRulesetRulesFileExtensionRestriction + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesFileExtensionRestriction; + +OrganizationRulesetRulesFileExtensionRestriction.builder() + .restrictedFileExtensions(java.util.List) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| restrictedFileExtensions | java.util.List | The file extensions that are restricted from being pushed to the commit graph. | + +--- + +##### `restrictedFileExtensions`Required + +```java +public java.util.List getRestrictedFileExtensions(); +``` + +- *Type:* java.util.List + +The file extensions that are restricted from being pushed to the commit graph. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#restricted_file_extensions OrganizationRuleset#restricted_file_extensions} + +--- + +### OrganizationRulesetRulesFilePathRestriction + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesFilePathRestriction; + +OrganizationRulesetRulesFilePathRestriction.builder() + .restrictedFilePaths(java.util.List) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| restrictedFilePaths | java.util.List | The file paths that are restricted from being pushed to the commit graph. | + +--- + +##### `restrictedFilePaths`Required + +```java +public java.util.List getRestrictedFilePaths(); +``` + +- *Type:* java.util.List + +The file paths that are restricted from being pushed to the commit graph. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#restricted_file_paths OrganizationRuleset#restricted_file_paths} + +--- + +### OrganizationRulesetRulesMaxFilePathLength + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesMaxFilePathLength; + +OrganizationRulesetRulesMaxFilePathLength.builder() + .maxFilePathLength(java.lang.Number) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| maxFilePathLength | java.lang.Number | The maximum allowed length of a file path. | + +--- + +##### `maxFilePathLength`Required + +```java +public java.lang.Number getMaxFilePathLength(); +``` + +- *Type:* java.lang.Number + +The maximum allowed length of a file path. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#max_file_path_length OrganizationRuleset#max_file_path_length} + +--- + +### OrganizationRulesetRulesMaxFileSize + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesMaxFileSize; + +OrganizationRulesetRulesMaxFileSize.builder() + .maxFileSize(java.lang.Number) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| maxFileSize | java.lang.Number | The maximum allowed size of a file in megabytes (MB). Valid range is 1-100 MB. | + +--- + +##### `maxFileSize`Required + +```java +public java.lang.Number getMaxFileSize(); +``` + +- *Type:* java.lang.Number + +The maximum allowed size of a file in megabytes (MB). Valid range is 1-100 MB. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#max_file_size OrganizationRuleset#max_file_size} + +--- + +### OrganizationRulesetRulesPullRequest + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesPullRequest; + +OrganizationRulesetRulesPullRequest.builder() +// .allowedMergeMethods(java.util.List) +// .dismissStaleReviewsOnPush(java.lang.Boolean|IResolvable) +// .requireCodeOwnerReview(java.lang.Boolean|IResolvable) +// .requiredApprovingReviewCount(java.lang.Number) +// .requiredReviewers(IResolvable|java.util.List) +// .requiredReviewThreadResolution(java.lang.Boolean|IResolvable) +// .requireLastPushApproval(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| allowedMergeMethods | java.util.List | Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled. | +| dismissStaleReviewsOnPush | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | New, reviewable commits pushed will dismiss previous pull request review approvals. Defaults to `false`. | +| requireCodeOwnerReview | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Require an approving review in pull requests that modify files that have a designated code owner. Defaults to `false`. | +| requiredApprovingReviewCount | java.lang.Number | The number of approving reviews that are required before a pull request can be merged. Defaults to `0`. | +| requiredReviewers | io.cdktn.cdktn.IResolvable\|java.util.List<OrganizationRulesetRulesPullRequestRequiredReviewers> | required_reviewers block. | +| requiredReviewThreadResolution | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | All conversations on code must be resolved before a pull request can be merged. Defaults to `false`. | +| requireLastPushApproval | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether the most recent reviewable push must be approved by someone other than the person who pushed it. | + +--- + +##### `allowedMergeMethods`Optional + +```java +public java.util.List getAllowedMergeMethods(); +``` + +- *Type:* java.util.List + +Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#allowed_merge_methods OrganizationRuleset#allowed_merge_methods} + +--- + +##### `dismissStaleReviewsOnPush`Optional + +```java +public java.lang.Boolean|IResolvable getDismissStaleReviewsOnPush(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +New, reviewable commits pushed will dismiss previous pull request review approvals. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#dismiss_stale_reviews_on_push OrganizationRuleset#dismiss_stale_reviews_on_push} + +--- + +##### `requireCodeOwnerReview`Optional + +```java +public java.lang.Boolean|IResolvable getRequireCodeOwnerReview(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Require an approving review in pull requests that modify files that have a designated code owner. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#require_code_owner_review OrganizationRuleset#require_code_owner_review} + +--- + +##### `requiredApprovingReviewCount`Optional + +```java +public java.lang.Number getRequiredApprovingReviewCount(); +``` + +- *Type:* java.lang.Number + +The number of approving reviews that are required before a pull request can be merged. Defaults to `0`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#required_approving_review_count OrganizationRuleset#required_approving_review_count} + +--- + +##### `requiredReviewers`Optional + +```java +public IResolvable|java.util.List getRequiredReviewers(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetRulesPullRequestRequiredReviewers> + +required_reviewers block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#required_reviewers OrganizationRuleset#required_reviewers} + +--- + +##### `requiredReviewThreadResolution`Optional + +```java +public java.lang.Boolean|IResolvable getRequiredReviewThreadResolution(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +All conversations on code must be resolved before a pull request can be merged. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#required_review_thread_resolution OrganizationRuleset#required_review_thread_resolution} + +--- + +##### `requireLastPushApproval`Optional + +```java +public java.lang.Boolean|IResolvable getRequireLastPushApproval(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether the most recent reviewable push must be approved by someone other than the person who pushed it. + +Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#require_last_push_approval OrganizationRuleset#require_last_push_approval} + +--- + +### OrganizationRulesetRulesPullRequestRequiredReviewers + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesPullRequestRequiredReviewers; + +OrganizationRulesetRulesPullRequestRequiredReviewers.builder() + .filePatterns(java.util.List) + .minimumApprovals(java.lang.Number) + .reviewer(OrganizationRulesetRulesPullRequestRequiredReviewersReviewer) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| filePatterns | java.util.List | File patterns (fnmatch syntax) that this reviewer must approve. | +| minimumApprovals | java.lang.Number | Minimum number of approvals required from this reviewer. Set to 0 to make approval optional. | +| reviewer | OrganizationRulesetRulesPullRequestRequiredReviewersReviewer | reviewer block. | + +--- + +##### `filePatterns`Required + +```java +public java.util.List getFilePatterns(); +``` + +- *Type:* java.util.List + +File patterns (fnmatch syntax) that this reviewer must approve. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#file_patterns OrganizationRuleset#file_patterns} + +--- + +##### `minimumApprovals`Required + +```java +public java.lang.Number getMinimumApprovals(); +``` + +- *Type:* java.lang.Number + +Minimum number of approvals required from this reviewer. Set to 0 to make approval optional. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#minimum_approvals OrganizationRuleset#minimum_approvals} + +--- + +##### `reviewer`Required + +```java +public OrganizationRulesetRulesPullRequestRequiredReviewersReviewer getReviewer(); +``` + +- *Type:* OrganizationRulesetRulesPullRequestRequiredReviewersReviewer + +reviewer block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#reviewer OrganizationRuleset#reviewer} + +--- + +### OrganizationRulesetRulesPullRequestRequiredReviewersReviewer + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesPullRequestRequiredReviewersReviewer; + +OrganizationRulesetRulesPullRequestRequiredReviewersReviewer.builder() + .id(java.lang.Number) + .type(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| id | java.lang.Number | The ID of the reviewer that must review. | +| type | java.lang.String | The type of reviewer. Currently only `Team` is supported. | + +--- + +##### `id`Required + +```java +public java.lang.Number getId(); +``` + +- *Type:* java.lang.Number + +The ID of the reviewer that must review. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#id OrganizationRuleset#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`Required + +```java +public java.lang.String getType(); +``` + +- *Type:* java.lang.String + +The type of reviewer. Currently only `Team` is supported. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#type OrganizationRuleset#type} + +--- + +### OrganizationRulesetRulesRequiredCodeScanning + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesRequiredCodeScanning; + +OrganizationRulesetRulesRequiredCodeScanning.builder() + .requiredCodeScanningTool(IResolvable|java.util.List) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| requiredCodeScanningTool | io.cdktn.cdktn.IResolvable\|java.util.List<OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool> | required_code_scanning_tool block. | + +--- + +##### `requiredCodeScanningTool`Required + +```java +public IResolvable|java.util.List getRequiredCodeScanningTool(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool> + +required_code_scanning_tool block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#required_code_scanning_tool OrganizationRuleset#required_code_scanning_tool} + +--- + +### OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool; + +OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool.builder() + .alertsThreshold(java.lang.String) + .securityAlertsThreshold(java.lang.String) + .tool(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| alertsThreshold | java.lang.String | The severity level at which code scanning results that raise alerts block a reference update. | +| securityAlertsThreshold | java.lang.String | The severity level at which code scanning results that raise security alerts block a reference update. | +| tool | java.lang.String | The name of a code scanning tool. | + +--- + +##### `alertsThreshold`Required + +```java +public java.lang.String getAlertsThreshold(); +``` + +- *Type:* java.lang.String + +The severity level at which code scanning results that raise alerts block a reference update. + +Can be one of: `none`, `errors`, `errors_and_warnings`, `all`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#alerts_threshold OrganizationRuleset#alerts_threshold} + +--- + +##### `securityAlertsThreshold`Required + +```java +public java.lang.String getSecurityAlertsThreshold(); +``` + +- *Type:* java.lang.String + +The severity level at which code scanning results that raise security alerts block a reference update. + +Can be one of: `none`, `critical`, `high_or_higher`, `medium_or_higher`, `all`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#security_alerts_threshold OrganizationRuleset#security_alerts_threshold} + +--- + +##### `tool`Required + +```java +public java.lang.String getTool(); +``` + +- *Type:* java.lang.String + +The name of a code scanning tool. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#tool OrganizationRuleset#tool} + +--- + +### OrganizationRulesetRulesRequiredStatusChecks + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesRequiredStatusChecks; + +OrganizationRulesetRulesRequiredStatusChecks.builder() + .requiredCheck(IResolvable|java.util.List) +// .doNotEnforceOnCreate(java.lang.Boolean|IResolvable) +// .strictRequiredStatusChecksPolicy(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| requiredCheck | io.cdktn.cdktn.IResolvable\|java.util.List<OrganizationRulesetRulesRequiredStatusChecksRequiredCheck> | required_check block. | +| doNotEnforceOnCreate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Allow repositories and branches to be created if a check would otherwise prohibit it. | +| strictRequiredStatusChecksPolicy | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether pull requests targeting a matching branch must be tested with the latest code. | + +--- + +##### `requiredCheck`Required + +```java +public IResolvable|java.util.List getRequiredCheck(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetRulesRequiredStatusChecksRequiredCheck> + +required_check block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#required_check OrganizationRuleset#required_check} + +--- + +##### `doNotEnforceOnCreate`Optional + +```java +public java.lang.Boolean|IResolvable getDoNotEnforceOnCreate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Allow repositories and branches to be created if a check would otherwise prohibit it. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#do_not_enforce_on_create OrganizationRuleset#do_not_enforce_on_create} + +--- + +##### `strictRequiredStatusChecksPolicy`Optional + +```java +public java.lang.Boolean|IResolvable getStrictRequiredStatusChecksPolicy(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether pull requests targeting a matching branch must be tested with the latest code. + +This setting will not take effect unless at least one status check is enabled. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#strict_required_status_checks_policy OrganizationRuleset#strict_required_status_checks_policy} + +--- + +### OrganizationRulesetRulesRequiredStatusChecksRequiredCheck + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesRequiredStatusChecksRequiredCheck; + +OrganizationRulesetRulesRequiredStatusChecksRequiredCheck.builder() + .context(java.lang.String) +// .integrationId(java.lang.Number) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| context | java.lang.String | The status check context name that must be present on the commit. | +| integrationId | java.lang.Number | The optional integration ID that this status check must originate from. | + +--- + +##### `context`Required + +```java +public java.lang.String getContext(); +``` + +- *Type:* java.lang.String + +The status check context name that must be present on the commit. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#context OrganizationRuleset#context} + +--- + +##### `integrationId`Optional + +```java +public java.lang.Number getIntegrationId(); +``` + +- *Type:* java.lang.Number + +The optional integration ID that this status check must originate from. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#integration_id OrganizationRuleset#integration_id} + +--- + +### OrganizationRulesetRulesRequiredWorkflows + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesRequiredWorkflows; + +OrganizationRulesetRulesRequiredWorkflows.builder() + .requiredWorkflow(IResolvable|java.util.List) +// .doNotEnforceOnCreate(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| requiredWorkflow | io.cdktn.cdktn.IResolvable\|java.util.List<OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow> | required_workflow block. | +| doNotEnforceOnCreate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Allow repositories and branches to be created if a check would otherwise prohibit it. | + +--- + +##### `requiredWorkflow`Required + +```java +public IResolvable|java.util.List getRequiredWorkflow(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow> + +required_workflow block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#required_workflow OrganizationRuleset#required_workflow} + +--- + +##### `doNotEnforceOnCreate`Optional + +```java +public java.lang.Boolean|IResolvable getDoNotEnforceOnCreate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Allow repositories and branches to be created if a check would otherwise prohibit it. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#do_not_enforce_on_create OrganizationRuleset#do_not_enforce_on_create} + +--- + +### OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow; + +OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow.builder() + .path(java.lang.String) + .repositoryId(java.lang.Number) +// .ref(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| path | java.lang.String | The path to the workflow YAML definition file. | +| repositoryId | java.lang.Number | The repository in which the workflow is defined. | +| ref | java.lang.String | The ref (branch or tag) of the workflow file to use. | + +--- + +##### `path`Required + +```java +public java.lang.String getPath(); +``` + +- *Type:* java.lang.String + +The path to the workflow YAML definition file. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#path OrganizationRuleset#path} + +--- + +##### `repositoryId`Required + +```java +public java.lang.Number getRepositoryId(); +``` + +- *Type:* java.lang.Number + +The repository in which the workflow is defined. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#repository_id OrganizationRuleset#repository_id} + +--- + +##### `ref`Optional + +```java +public java.lang.String getRef(); +``` + +- *Type:* java.lang.String + +The ref (branch or tag) of the workflow file to use. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#ref OrganizationRuleset#ref} + +--- + +### OrganizationRulesetRulesTagNamePattern + +#### Initializer + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesTagNamePattern; + +OrganizationRulesetRulesTagNamePattern.builder() + .operator(java.lang.String) + .pattern(java.lang.String) +// .name(java.lang.String) +// .negate(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| operator | java.lang.String | The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. | +| pattern | java.lang.String | The pattern to match with. | +| name | java.lang.String | How this rule will appear to users. | +| negate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | If true, the rule will fail if the pattern matches. | + +--- + +##### `operator`Required + +```java +public java.lang.String getOperator(); +``` + +- *Type:* java.lang.String + +The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#operator OrganizationRuleset#operator} + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +The pattern to match with. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#pattern OrganizationRuleset#pattern} + +--- + +##### `name`Optional + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +How this rule will appear to users. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#name OrganizationRuleset#name} + +--- + +##### `negate`Optional + +```java +public java.lang.Boolean|IResolvable getNegate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +If true, the rule will fail if the pattern matches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_ruleset#negate OrganizationRuleset#negate} + +--- + +## Classes + +### OrganizationRulesetBypassActorsList + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetBypassActorsList; + +new OrganizationRulesetBypassActorsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public OrganizationRulesetBypassActorsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|java.util.List<OrganizationRulesetBypassActors> | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|java.util.List getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetBypassActors> + +--- + + +### OrganizationRulesetBypassActorsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetBypassActorsOutputReference; + +new OrganizationRulesetBypassActorsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetActorId | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetActorId` + +```java +public void resetActorId() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| actorIdInput | java.lang.Number | *No description.* | +| actorTypeInput | java.lang.String | *No description.* | +| bypassModeInput | java.lang.String | *No description.* | +| actorId | java.lang.Number | *No description.* | +| actorType | java.lang.String | *No description.* | +| bypassMode | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|OrganizationRulesetBypassActors | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `actorIdInput`Optional + +```java +public java.lang.Number getActorIdInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `actorTypeInput`Optional + +```java +public java.lang.String getActorTypeInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `bypassModeInput`Optional + +```java +public java.lang.String getBypassModeInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `actorId`Required + +```java +public java.lang.Number getActorId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `actorType`Required + +```java +public java.lang.String getActorType(); +``` + +- *Type:* java.lang.String + +--- + +##### `bypassMode`Required + +```java +public java.lang.String getBypassMode(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|OrganizationRulesetBypassActors getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|OrganizationRulesetBypassActors + +--- + + +### OrganizationRulesetConditionsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetConditionsOutputReference; + +new OrganizationRulesetConditionsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| putRefName | *No description.* | +| putRepositoryName | *No description.* | +| putRepositoryProperty | *No description.* | +| resetRefName | *No description.* | +| resetRepositoryId | *No description.* | +| resetRepositoryName | *No description.* | +| resetRepositoryProperty | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `putRefName` + +```java +public void putRefName(OrganizationRulesetConditionsRefName value) +``` + +###### `value`Required + +- *Type:* OrganizationRulesetConditionsRefName + +--- + +##### `putRepositoryName` + +```java +public void putRepositoryName(OrganizationRulesetConditionsRepositoryName value) +``` + +###### `value`Required + +- *Type:* OrganizationRulesetConditionsRepositoryName + +--- + +##### `putRepositoryProperty` + +```java +public void putRepositoryProperty(OrganizationRulesetConditionsRepositoryProperty value) +``` + +###### `value`Required + +- *Type:* OrganizationRulesetConditionsRepositoryProperty + +--- + +##### `resetRefName` + +```java +public void resetRefName() +``` + +##### `resetRepositoryId` + +```java +public void resetRepositoryId() +``` + +##### `resetRepositoryName` + +```java +public void resetRepositoryName() +``` + +##### `resetRepositoryProperty` + +```java +public void resetRepositoryProperty() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| refName | OrganizationRulesetConditionsRefNameOutputReference | *No description.* | +| repositoryName | OrganizationRulesetConditionsRepositoryNameOutputReference | *No description.* | +| repositoryProperty | OrganizationRulesetConditionsRepositoryPropertyOutputReference | *No description.* | +| refNameInput | OrganizationRulesetConditionsRefName | *No description.* | +| repositoryIdInput | java.util.List | *No description.* | +| repositoryNameInput | OrganizationRulesetConditionsRepositoryName | *No description.* | +| repositoryPropertyInput | OrganizationRulesetConditionsRepositoryProperty | *No description.* | +| repositoryId | java.util.List | *No description.* | +| internalValue | OrganizationRulesetConditions | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `refName`Required + +```java +public OrganizationRulesetConditionsRefNameOutputReference getRefName(); +``` + +- *Type:* OrganizationRulesetConditionsRefNameOutputReference + +--- + +##### `repositoryName`Required + +```java +public OrganizationRulesetConditionsRepositoryNameOutputReference getRepositoryName(); +``` + +- *Type:* OrganizationRulesetConditionsRepositoryNameOutputReference + +--- + +##### `repositoryProperty`Required + +```java +public OrganizationRulesetConditionsRepositoryPropertyOutputReference getRepositoryProperty(); +``` + +- *Type:* OrganizationRulesetConditionsRepositoryPropertyOutputReference + +--- + +##### `refNameInput`Optional + +```java +public OrganizationRulesetConditionsRefName getRefNameInput(); +``` + +- *Type:* OrganizationRulesetConditionsRefName + +--- + +##### `repositoryIdInput`Optional + +```java +public java.util.List getRepositoryIdInput(); +``` + +- *Type:* java.util.List + +--- + +##### `repositoryNameInput`Optional + +```java +public OrganizationRulesetConditionsRepositoryName getRepositoryNameInput(); +``` + +- *Type:* OrganizationRulesetConditionsRepositoryName + +--- + +##### `repositoryPropertyInput`Optional + +```java +public OrganizationRulesetConditionsRepositoryProperty getRepositoryPropertyInput(); +``` + +- *Type:* OrganizationRulesetConditionsRepositoryProperty + +--- + +##### `repositoryId`Required + +```java +public java.util.List getRepositoryId(); +``` + +- *Type:* java.util.List + +--- + +##### `internalValue`Optional + +```java +public OrganizationRulesetConditions getInternalValue(); +``` + +- *Type:* OrganizationRulesetConditions + +--- + + +### OrganizationRulesetConditionsRefNameOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetConditionsRefNameOutputReference; + +new OrganizationRulesetConditionsRefNameOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| excludeInput | java.util.List | *No description.* | +| includeInput | java.util.List | *No description.* | +| exclude | java.util.List | *No description.* | +| include | java.util.List | *No description.* | +| internalValue | OrganizationRulesetConditionsRefName | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `excludeInput`Optional + +```java +public java.util.List getExcludeInput(); +``` + +- *Type:* java.util.List + +--- + +##### `includeInput`Optional + +```java +public java.util.List getIncludeInput(); +``` + +- *Type:* java.util.List + +--- + +##### `exclude`Required + +```java +public java.util.List getExclude(); +``` + +- *Type:* java.util.List + +--- + +##### `include`Required + +```java +public java.util.List getInclude(); +``` + +- *Type:* java.util.List + +--- + +##### `internalValue`Optional + +```java +public OrganizationRulesetConditionsRefName getInternalValue(); +``` + +- *Type:* OrganizationRulesetConditionsRefName + +--- + + +### OrganizationRulesetConditionsRepositoryNameOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetConditionsRepositoryNameOutputReference; + +new OrganizationRulesetConditionsRepositoryNameOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetProtected | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetProtected` + +```java +public void resetProtected() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| excludeInput | java.util.List | *No description.* | +| includeInput | java.util.List | *No description.* | +| protectedInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| exclude | java.util.List | *No description.* | +| include | java.util.List | *No description.* | +| protected | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| internalValue | OrganizationRulesetConditionsRepositoryName | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `excludeInput`Optional + +```java +public java.util.List getExcludeInput(); +``` + +- *Type:* java.util.List + +--- + +##### `includeInput`Optional + +```java +public java.util.List getIncludeInput(); +``` + +- *Type:* java.util.List + +--- + +##### `protectedInput`Optional + +```java +public java.lang.Boolean|IResolvable getProtectedInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `exclude`Required + +```java +public java.util.List getExclude(); +``` + +- *Type:* java.util.List + +--- + +##### `include`Required + +```java +public java.util.List getInclude(); +``` + +- *Type:* java.util.List + +--- + +##### `protected`Required + +```java +public java.lang.Boolean|IResolvable getProtected(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `internalValue`Optional + +```java +public OrganizationRulesetConditionsRepositoryName getInternalValue(); +``` + +- *Type:* OrganizationRulesetConditionsRepositoryName + +--- + + +### OrganizationRulesetConditionsRepositoryPropertyExcludeList + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetConditionsRepositoryPropertyExcludeList; + +new OrganizationRulesetConditionsRepositoryPropertyExcludeList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public OrganizationRulesetConditionsRepositoryPropertyExcludeOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|java.util.List<OrganizationRulesetConditionsRepositoryPropertyExclude> | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|java.util.List getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetConditionsRepositoryPropertyExclude> + +--- + + +### OrganizationRulesetConditionsRepositoryPropertyExcludeOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetConditionsRepositoryPropertyExcludeOutputReference; + +new OrganizationRulesetConditionsRepositoryPropertyExcludeOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetName | *No description.* | +| resetPropertyValues | *No description.* | +| resetSource | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetName` + +```java +public void resetName() +``` + +##### `resetPropertyValues` + +```java +public void resetPropertyValues() +``` + +##### `resetSource` + +```java +public void resetSource() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| propertyValuesInput | java.util.List | *No description.* | +| sourceInput | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| propertyValues | java.util.List | *No description.* | +| source | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|OrganizationRulesetConditionsRepositoryPropertyExclude | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `propertyValuesInput`Optional + +```java +public java.util.List getPropertyValuesInput(); +``` + +- *Type:* java.util.List + +--- + +##### `sourceInput`Optional + +```java +public java.lang.String getSourceInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `propertyValues`Required + +```java +public java.util.List getPropertyValues(); +``` + +- *Type:* java.util.List + +--- + +##### `source`Required + +```java +public java.lang.String getSource(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|OrganizationRulesetConditionsRepositoryPropertyExclude getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|OrganizationRulesetConditionsRepositoryPropertyExclude + +--- + + +### OrganizationRulesetConditionsRepositoryPropertyIncludeList + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetConditionsRepositoryPropertyIncludeList; + +new OrganizationRulesetConditionsRepositoryPropertyIncludeList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public OrganizationRulesetConditionsRepositoryPropertyIncludeOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|java.util.List<OrganizationRulesetConditionsRepositoryPropertyInclude> | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|java.util.List getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetConditionsRepositoryPropertyInclude> + +--- + + +### OrganizationRulesetConditionsRepositoryPropertyIncludeOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetConditionsRepositoryPropertyIncludeOutputReference; + +new OrganizationRulesetConditionsRepositoryPropertyIncludeOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetName | *No description.* | +| resetPropertyValues | *No description.* | +| resetSource | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetName` + +```java +public void resetName() +``` + +##### `resetPropertyValues` + +```java +public void resetPropertyValues() +``` + +##### `resetSource` + +```java +public void resetSource() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| propertyValuesInput | java.util.List | *No description.* | +| sourceInput | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| propertyValues | java.util.List | *No description.* | +| source | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|OrganizationRulesetConditionsRepositoryPropertyInclude | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `propertyValuesInput`Optional + +```java +public java.util.List getPropertyValuesInput(); +``` + +- *Type:* java.util.List + +--- + +##### `sourceInput`Optional + +```java +public java.lang.String getSourceInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `propertyValues`Required + +```java +public java.util.List getPropertyValues(); +``` + +- *Type:* java.util.List + +--- + +##### `source`Required + +```java +public java.lang.String getSource(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|OrganizationRulesetConditionsRepositoryPropertyInclude getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|OrganizationRulesetConditionsRepositoryPropertyInclude + +--- + + +### OrganizationRulesetConditionsRepositoryPropertyOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetConditionsRepositoryPropertyOutputReference; + +new OrganizationRulesetConditionsRepositoryPropertyOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| putExclude | *No description.* | +| putInclude | *No description.* | +| resetExclude | *No description.* | +| resetInclude | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `putExclude` + +```java +public void putExclude(IResolvable|java.util.List value) +``` + +###### `value`Required + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetConditionsRepositoryPropertyExclude> + +--- + +##### `putInclude` + +```java +public void putInclude(IResolvable|java.util.List value) +``` + +###### `value`Required + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetConditionsRepositoryPropertyInclude> + +--- + +##### `resetExclude` + +```java +public void resetExclude() +``` + +##### `resetInclude` + +```java +public void resetInclude() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| exclude | OrganizationRulesetConditionsRepositoryPropertyExcludeList | *No description.* | +| include | OrganizationRulesetConditionsRepositoryPropertyIncludeList | *No description.* | +| excludeInput | io.cdktn.cdktn.IResolvable\|java.util.List<OrganizationRulesetConditionsRepositoryPropertyExclude> | *No description.* | +| includeInput | io.cdktn.cdktn.IResolvable\|java.util.List<OrganizationRulesetConditionsRepositoryPropertyInclude> | *No description.* | +| internalValue | OrganizationRulesetConditionsRepositoryProperty | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `exclude`Required + +```java +public OrganizationRulesetConditionsRepositoryPropertyExcludeList getExclude(); +``` + +- *Type:* OrganizationRulesetConditionsRepositoryPropertyExcludeList + +--- + +##### `include`Required + +```java +public OrganizationRulesetConditionsRepositoryPropertyIncludeList getInclude(); +``` + +- *Type:* OrganizationRulesetConditionsRepositoryPropertyIncludeList + +--- + +##### `excludeInput`Optional + +```java +public IResolvable|java.util.List getExcludeInput(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetConditionsRepositoryPropertyExclude> + +--- + +##### `includeInput`Optional + +```java +public IResolvable|java.util.List getIncludeInput(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetConditionsRepositoryPropertyInclude> + +--- + +##### `internalValue`Optional + +```java +public OrganizationRulesetConditionsRepositoryProperty getInternalValue(); +``` + +- *Type:* OrganizationRulesetConditionsRepositoryProperty + +--- + + +### OrganizationRulesetRulesBranchNamePatternOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesBranchNamePatternOutputReference; + +new OrganizationRulesetRulesBranchNamePatternOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetName | *No description.* | +| resetNegate | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetName` + +```java +public void resetName() +``` + +##### `resetNegate` + +```java +public void resetNegate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| negateInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| operatorInput | java.lang.String | *No description.* | +| patternInput | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| negate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| operator | java.lang.String | *No description.* | +| pattern | java.lang.String | *No description.* | +| internalValue | OrganizationRulesetRulesBranchNamePattern | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `negateInput`Optional + +```java +public java.lang.Boolean|IResolvable getNegateInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `operatorInput`Optional + +```java +public java.lang.String getOperatorInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `patternInput`Optional + +```java +public java.lang.String getPatternInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `negate`Required + +```java +public java.lang.Boolean|IResolvable getNegate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `operator`Required + +```java +public java.lang.String getOperator(); +``` + +- *Type:* java.lang.String + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public OrganizationRulesetRulesBranchNamePattern getInternalValue(); +``` + +- *Type:* OrganizationRulesetRulesBranchNamePattern + +--- + + +### OrganizationRulesetRulesCommitAuthorEmailPatternOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesCommitAuthorEmailPatternOutputReference; + +new OrganizationRulesetRulesCommitAuthorEmailPatternOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetName | *No description.* | +| resetNegate | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetName` + +```java +public void resetName() +``` + +##### `resetNegate` + +```java +public void resetNegate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| negateInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| operatorInput | java.lang.String | *No description.* | +| patternInput | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| negate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| operator | java.lang.String | *No description.* | +| pattern | java.lang.String | *No description.* | +| internalValue | OrganizationRulesetRulesCommitAuthorEmailPattern | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `negateInput`Optional + +```java +public java.lang.Boolean|IResolvable getNegateInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `operatorInput`Optional + +```java +public java.lang.String getOperatorInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `patternInput`Optional + +```java +public java.lang.String getPatternInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `negate`Required + +```java +public java.lang.Boolean|IResolvable getNegate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `operator`Required + +```java +public java.lang.String getOperator(); +``` + +- *Type:* java.lang.String + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public OrganizationRulesetRulesCommitAuthorEmailPattern getInternalValue(); +``` + +- *Type:* OrganizationRulesetRulesCommitAuthorEmailPattern + +--- + + +### OrganizationRulesetRulesCommitMessagePatternOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesCommitMessagePatternOutputReference; + +new OrganizationRulesetRulesCommitMessagePatternOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetName | *No description.* | +| resetNegate | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetName` + +```java +public void resetName() +``` + +##### `resetNegate` + +```java +public void resetNegate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| negateInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| operatorInput | java.lang.String | *No description.* | +| patternInput | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| negate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| operator | java.lang.String | *No description.* | +| pattern | java.lang.String | *No description.* | +| internalValue | OrganizationRulesetRulesCommitMessagePattern | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `negateInput`Optional + +```java +public java.lang.Boolean|IResolvable getNegateInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `operatorInput`Optional + +```java +public java.lang.String getOperatorInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `patternInput`Optional + +```java +public java.lang.String getPatternInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `negate`Required + +```java +public java.lang.Boolean|IResolvable getNegate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `operator`Required + +```java +public java.lang.String getOperator(); +``` + +- *Type:* java.lang.String + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public OrganizationRulesetRulesCommitMessagePattern getInternalValue(); +``` + +- *Type:* OrganizationRulesetRulesCommitMessagePattern + +--- + + +### OrganizationRulesetRulesCommitterEmailPatternOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesCommitterEmailPatternOutputReference; + +new OrganizationRulesetRulesCommitterEmailPatternOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetName | *No description.* | +| resetNegate | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetName` + +```java +public void resetName() +``` + +##### `resetNegate` + +```java +public void resetNegate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| negateInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| operatorInput | java.lang.String | *No description.* | +| patternInput | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| negate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| operator | java.lang.String | *No description.* | +| pattern | java.lang.String | *No description.* | +| internalValue | OrganizationRulesetRulesCommitterEmailPattern | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `negateInput`Optional + +```java +public java.lang.Boolean|IResolvable getNegateInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `operatorInput`Optional + +```java +public java.lang.String getOperatorInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `patternInput`Optional + +```java +public java.lang.String getPatternInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `negate`Required + +```java +public java.lang.Boolean|IResolvable getNegate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `operator`Required + +```java +public java.lang.String getOperator(); +``` + +- *Type:* java.lang.String + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public OrganizationRulesetRulesCommitterEmailPattern getInternalValue(); +``` + +- *Type:* OrganizationRulesetRulesCommitterEmailPattern + +--- + + +### OrganizationRulesetRulesCopilotCodeReviewOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesCopilotCodeReviewOutputReference; + +new OrganizationRulesetRulesCopilotCodeReviewOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetReviewDraftPullRequests | *No description.* | +| resetReviewOnPush | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetReviewDraftPullRequests` + +```java +public void resetReviewDraftPullRequests() +``` + +##### `resetReviewOnPush` + +```java +public void resetReviewOnPush() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| reviewDraftPullRequestsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| reviewOnPushInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| reviewDraftPullRequests | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| reviewOnPush | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| internalValue | OrganizationRulesetRulesCopilotCodeReview | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `reviewDraftPullRequestsInput`Optional + +```java +public java.lang.Boolean|IResolvable getReviewDraftPullRequestsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `reviewOnPushInput`Optional + +```java +public java.lang.Boolean|IResolvable getReviewOnPushInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `reviewDraftPullRequests`Required + +```java +public java.lang.Boolean|IResolvable getReviewDraftPullRequests(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `reviewOnPush`Required + +```java +public java.lang.Boolean|IResolvable getReviewOnPush(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `internalValue`Optional + +```java +public OrganizationRulesetRulesCopilotCodeReview getInternalValue(); +``` + +- *Type:* OrganizationRulesetRulesCopilotCodeReview + +--- + + +### OrganizationRulesetRulesFileExtensionRestrictionOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesFileExtensionRestrictionOutputReference; + +new OrganizationRulesetRulesFileExtensionRestrictionOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| restrictedFileExtensionsInput | java.util.List | *No description.* | +| restrictedFileExtensions | java.util.List | *No description.* | +| internalValue | OrganizationRulesetRulesFileExtensionRestriction | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `restrictedFileExtensionsInput`Optional + +```java +public java.util.List getRestrictedFileExtensionsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `restrictedFileExtensions`Required + +```java +public java.util.List getRestrictedFileExtensions(); +``` + +- *Type:* java.util.List + +--- + +##### `internalValue`Optional + +```java +public OrganizationRulesetRulesFileExtensionRestriction getInternalValue(); +``` + +- *Type:* OrganizationRulesetRulesFileExtensionRestriction + +--- + + +### OrganizationRulesetRulesFilePathRestrictionOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesFilePathRestrictionOutputReference; + +new OrganizationRulesetRulesFilePathRestrictionOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| restrictedFilePathsInput | java.util.List | *No description.* | +| restrictedFilePaths | java.util.List | *No description.* | +| internalValue | OrganizationRulesetRulesFilePathRestriction | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `restrictedFilePathsInput`Optional + +```java +public java.util.List getRestrictedFilePathsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `restrictedFilePaths`Required + +```java +public java.util.List getRestrictedFilePaths(); +``` + +- *Type:* java.util.List + +--- + +##### `internalValue`Optional + +```java +public OrganizationRulesetRulesFilePathRestriction getInternalValue(); +``` + +- *Type:* OrganizationRulesetRulesFilePathRestriction + +--- + + +### OrganizationRulesetRulesMaxFilePathLengthOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesMaxFilePathLengthOutputReference; + +new OrganizationRulesetRulesMaxFilePathLengthOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| maxFilePathLengthInput | java.lang.Number | *No description.* | +| maxFilePathLength | java.lang.Number | *No description.* | +| internalValue | OrganizationRulesetRulesMaxFilePathLength | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `maxFilePathLengthInput`Optional + +```java +public java.lang.Number getMaxFilePathLengthInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `maxFilePathLength`Required + +```java +public java.lang.Number getMaxFilePathLength(); +``` + +- *Type:* java.lang.Number + +--- + +##### `internalValue`Optional + +```java +public OrganizationRulesetRulesMaxFilePathLength getInternalValue(); +``` + +- *Type:* OrganizationRulesetRulesMaxFilePathLength + +--- + + +### OrganizationRulesetRulesMaxFileSizeOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesMaxFileSizeOutputReference; + +new OrganizationRulesetRulesMaxFileSizeOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| maxFileSizeInput | java.lang.Number | *No description.* | +| maxFileSize | java.lang.Number | *No description.* | +| internalValue | OrganizationRulesetRulesMaxFileSize | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `maxFileSizeInput`Optional + +```java +public java.lang.Number getMaxFileSizeInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `maxFileSize`Required + +```java +public java.lang.Number getMaxFileSize(); +``` + +- *Type:* java.lang.Number + +--- + +##### `internalValue`Optional + +```java +public OrganizationRulesetRulesMaxFileSize getInternalValue(); +``` + +- *Type:* OrganizationRulesetRulesMaxFileSize + +--- + + +### OrganizationRulesetRulesOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesOutputReference; + +new OrganizationRulesetRulesOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| putBranchNamePattern | *No description.* | +| putCommitAuthorEmailPattern | *No description.* | +| putCommitMessagePattern | *No description.* | +| putCommitterEmailPattern | *No description.* | +| putCopilotCodeReview | *No description.* | +| putFileExtensionRestriction | *No description.* | +| putFilePathRestriction | *No description.* | +| putMaxFilePathLength | *No description.* | +| putMaxFileSize | *No description.* | +| putPullRequest | *No description.* | +| putRequiredCodeScanning | *No description.* | +| putRequiredStatusChecks | *No description.* | +| putRequiredWorkflows | *No description.* | +| putTagNamePattern | *No description.* | +| resetBranchNamePattern | *No description.* | +| resetCommitAuthorEmailPattern | *No description.* | +| resetCommitMessagePattern | *No description.* | +| resetCommitterEmailPattern | *No description.* | +| resetCopilotCodeReview | *No description.* | +| resetCreation | *No description.* | +| resetDeletion | *No description.* | +| resetFileExtensionRestriction | *No description.* | +| resetFilePathRestriction | *No description.* | +| resetMaxFilePathLength | *No description.* | +| resetMaxFileSize | *No description.* | +| resetNonFastForward | *No description.* | +| resetPullRequest | *No description.* | +| resetRequiredCodeScanning | *No description.* | +| resetRequiredLinearHistory | *No description.* | +| resetRequiredSignatures | *No description.* | +| resetRequiredStatusChecks | *No description.* | +| resetRequiredWorkflows | *No description.* | +| resetTagNamePattern | *No description.* | +| resetUpdate | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `putBranchNamePattern` + +```java +public void putBranchNamePattern(OrganizationRulesetRulesBranchNamePattern value) +``` + +###### `value`Required + +- *Type:* OrganizationRulesetRulesBranchNamePattern + +--- + +##### `putCommitAuthorEmailPattern` + +```java +public void putCommitAuthorEmailPattern(OrganizationRulesetRulesCommitAuthorEmailPattern value) +``` + +###### `value`Required + +- *Type:* OrganizationRulesetRulesCommitAuthorEmailPattern + +--- + +##### `putCommitMessagePattern` + +```java +public void putCommitMessagePattern(OrganizationRulesetRulesCommitMessagePattern value) +``` + +###### `value`Required + +- *Type:* OrganizationRulesetRulesCommitMessagePattern + +--- + +##### `putCommitterEmailPattern` + +```java +public void putCommitterEmailPattern(OrganizationRulesetRulesCommitterEmailPattern value) +``` + +###### `value`Required + +- *Type:* OrganizationRulesetRulesCommitterEmailPattern + +--- + +##### `putCopilotCodeReview` + +```java +public void putCopilotCodeReview(OrganizationRulesetRulesCopilotCodeReview value) +``` + +###### `value`Required + +- *Type:* OrganizationRulesetRulesCopilotCodeReview + +--- + +##### `putFileExtensionRestriction` + +```java +public void putFileExtensionRestriction(OrganizationRulesetRulesFileExtensionRestriction value) +``` + +###### `value`Required + +- *Type:* OrganizationRulesetRulesFileExtensionRestriction + +--- + +##### `putFilePathRestriction` + +```java +public void putFilePathRestriction(OrganizationRulesetRulesFilePathRestriction value) +``` + +###### `value`Required + +- *Type:* OrganizationRulesetRulesFilePathRestriction + +--- + +##### `putMaxFilePathLength` + +```java +public void putMaxFilePathLength(OrganizationRulesetRulesMaxFilePathLength value) +``` + +###### `value`Required + +- *Type:* OrganizationRulesetRulesMaxFilePathLength + +--- + +##### `putMaxFileSize` + +```java +public void putMaxFileSize(OrganizationRulesetRulesMaxFileSize value) +``` + +###### `value`Required + +- *Type:* OrganizationRulesetRulesMaxFileSize + +--- + +##### `putPullRequest` + +```java +public void putPullRequest(OrganizationRulesetRulesPullRequest value) +``` + +###### `value`Required + +- *Type:* OrganizationRulesetRulesPullRequest + +--- + +##### `putRequiredCodeScanning` + +```java +public void putRequiredCodeScanning(OrganizationRulesetRulesRequiredCodeScanning value) +``` + +###### `value`Required + +- *Type:* OrganizationRulesetRulesRequiredCodeScanning + +--- + +##### `putRequiredStatusChecks` + +```java +public void putRequiredStatusChecks(OrganizationRulesetRulesRequiredStatusChecks value) +``` + +###### `value`Required + +- *Type:* OrganizationRulesetRulesRequiredStatusChecks + +--- + +##### `putRequiredWorkflows` + +```java +public void putRequiredWorkflows(OrganizationRulesetRulesRequiredWorkflows value) +``` + +###### `value`Required + +- *Type:* OrganizationRulesetRulesRequiredWorkflows + +--- + +##### `putTagNamePattern` + +```java +public void putTagNamePattern(OrganizationRulesetRulesTagNamePattern value) +``` + +###### `value`Required + +- *Type:* OrganizationRulesetRulesTagNamePattern + +--- + +##### `resetBranchNamePattern` + +```java +public void resetBranchNamePattern() +``` + +##### `resetCommitAuthorEmailPattern` + +```java +public void resetCommitAuthorEmailPattern() +``` + +##### `resetCommitMessagePattern` + +```java +public void resetCommitMessagePattern() +``` + +##### `resetCommitterEmailPattern` + +```java +public void resetCommitterEmailPattern() +``` + +##### `resetCopilotCodeReview` + +```java +public void resetCopilotCodeReview() +``` + +##### `resetCreation` + +```java +public void resetCreation() +``` + +##### `resetDeletion` + +```java +public void resetDeletion() +``` + +##### `resetFileExtensionRestriction` + +```java +public void resetFileExtensionRestriction() +``` + +##### `resetFilePathRestriction` + +```java +public void resetFilePathRestriction() +``` + +##### `resetMaxFilePathLength` + +```java +public void resetMaxFilePathLength() +``` + +##### `resetMaxFileSize` + +```java +public void resetMaxFileSize() +``` + +##### `resetNonFastForward` + +```java +public void resetNonFastForward() +``` + +##### `resetPullRequest` + +```java +public void resetPullRequest() +``` + +##### `resetRequiredCodeScanning` + +```java +public void resetRequiredCodeScanning() +``` + +##### `resetRequiredLinearHistory` + +```java +public void resetRequiredLinearHistory() +``` + +##### `resetRequiredSignatures` + +```java +public void resetRequiredSignatures() +``` + +##### `resetRequiredStatusChecks` + +```java +public void resetRequiredStatusChecks() +``` + +##### `resetRequiredWorkflows` + +```java +public void resetRequiredWorkflows() +``` + +##### `resetTagNamePattern` + +```java +public void resetTagNamePattern() +``` + +##### `resetUpdate` + +```java +public void resetUpdate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| branchNamePattern | OrganizationRulesetRulesBranchNamePatternOutputReference | *No description.* | +| commitAuthorEmailPattern | OrganizationRulesetRulesCommitAuthorEmailPatternOutputReference | *No description.* | +| commitMessagePattern | OrganizationRulesetRulesCommitMessagePatternOutputReference | *No description.* | +| committerEmailPattern | OrganizationRulesetRulesCommitterEmailPatternOutputReference | *No description.* | +| copilotCodeReview | OrganizationRulesetRulesCopilotCodeReviewOutputReference | *No description.* | +| fileExtensionRestriction | OrganizationRulesetRulesFileExtensionRestrictionOutputReference | *No description.* | +| filePathRestriction | OrganizationRulesetRulesFilePathRestrictionOutputReference | *No description.* | +| maxFilePathLength | OrganizationRulesetRulesMaxFilePathLengthOutputReference | *No description.* | +| maxFileSize | OrganizationRulesetRulesMaxFileSizeOutputReference | *No description.* | +| pullRequest | OrganizationRulesetRulesPullRequestOutputReference | *No description.* | +| requiredCodeScanning | OrganizationRulesetRulesRequiredCodeScanningOutputReference | *No description.* | +| requiredStatusChecks | OrganizationRulesetRulesRequiredStatusChecksOutputReference | *No description.* | +| requiredWorkflows | OrganizationRulesetRulesRequiredWorkflowsOutputReference | *No description.* | +| tagNamePattern | OrganizationRulesetRulesTagNamePatternOutputReference | *No description.* | +| branchNamePatternInput | OrganizationRulesetRulesBranchNamePattern | *No description.* | +| commitAuthorEmailPatternInput | OrganizationRulesetRulesCommitAuthorEmailPattern | *No description.* | +| commitMessagePatternInput | OrganizationRulesetRulesCommitMessagePattern | *No description.* | +| committerEmailPatternInput | OrganizationRulesetRulesCommitterEmailPattern | *No description.* | +| copilotCodeReviewInput | OrganizationRulesetRulesCopilotCodeReview | *No description.* | +| creationInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| deletionInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| fileExtensionRestrictionInput | OrganizationRulesetRulesFileExtensionRestriction | *No description.* | +| filePathRestrictionInput | OrganizationRulesetRulesFilePathRestriction | *No description.* | +| maxFilePathLengthInput | OrganizationRulesetRulesMaxFilePathLength | *No description.* | +| maxFileSizeInput | OrganizationRulesetRulesMaxFileSize | *No description.* | +| nonFastForwardInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| pullRequestInput | OrganizationRulesetRulesPullRequest | *No description.* | +| requiredCodeScanningInput | OrganizationRulesetRulesRequiredCodeScanning | *No description.* | +| requiredLinearHistoryInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requiredSignaturesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requiredStatusChecksInput | OrganizationRulesetRulesRequiredStatusChecks | *No description.* | +| requiredWorkflowsInput | OrganizationRulesetRulesRequiredWorkflows | *No description.* | +| tagNamePatternInput | OrganizationRulesetRulesTagNamePattern | *No description.* | +| updateInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| creation | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| deletion | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| nonFastForward | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requiredLinearHistory | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requiredSignatures | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| update | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| internalValue | OrganizationRulesetRules | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `branchNamePattern`Required + +```java +public OrganizationRulesetRulesBranchNamePatternOutputReference getBranchNamePattern(); +``` + +- *Type:* OrganizationRulesetRulesBranchNamePatternOutputReference + +--- + +##### `commitAuthorEmailPattern`Required + +```java +public OrganizationRulesetRulesCommitAuthorEmailPatternOutputReference getCommitAuthorEmailPattern(); +``` + +- *Type:* OrganizationRulesetRulesCommitAuthorEmailPatternOutputReference + +--- + +##### `commitMessagePattern`Required + +```java +public OrganizationRulesetRulesCommitMessagePatternOutputReference getCommitMessagePattern(); +``` + +- *Type:* OrganizationRulesetRulesCommitMessagePatternOutputReference + +--- + +##### `committerEmailPattern`Required + +```java +public OrganizationRulesetRulesCommitterEmailPatternOutputReference getCommitterEmailPattern(); +``` + +- *Type:* OrganizationRulesetRulesCommitterEmailPatternOutputReference + +--- + +##### `copilotCodeReview`Required + +```java +public OrganizationRulesetRulesCopilotCodeReviewOutputReference getCopilotCodeReview(); +``` + +- *Type:* OrganizationRulesetRulesCopilotCodeReviewOutputReference + +--- + +##### `fileExtensionRestriction`Required + +```java +public OrganizationRulesetRulesFileExtensionRestrictionOutputReference getFileExtensionRestriction(); +``` + +- *Type:* OrganizationRulesetRulesFileExtensionRestrictionOutputReference + +--- + +##### `filePathRestriction`Required + +```java +public OrganizationRulesetRulesFilePathRestrictionOutputReference getFilePathRestriction(); +``` + +- *Type:* OrganizationRulesetRulesFilePathRestrictionOutputReference + +--- + +##### `maxFilePathLength`Required + +```java +public OrganizationRulesetRulesMaxFilePathLengthOutputReference getMaxFilePathLength(); +``` + +- *Type:* OrganizationRulesetRulesMaxFilePathLengthOutputReference + +--- + +##### `maxFileSize`Required + +```java +public OrganizationRulesetRulesMaxFileSizeOutputReference getMaxFileSize(); +``` + +- *Type:* OrganizationRulesetRulesMaxFileSizeOutputReference + +--- + +##### `pullRequest`Required + +```java +public OrganizationRulesetRulesPullRequestOutputReference getPullRequest(); +``` + +- *Type:* OrganizationRulesetRulesPullRequestOutputReference + +--- + +##### `requiredCodeScanning`Required + +```java +public OrganizationRulesetRulesRequiredCodeScanningOutputReference getRequiredCodeScanning(); +``` + +- *Type:* OrganizationRulesetRulesRequiredCodeScanningOutputReference + +--- + +##### `requiredStatusChecks`Required + +```java +public OrganizationRulesetRulesRequiredStatusChecksOutputReference getRequiredStatusChecks(); +``` + +- *Type:* OrganizationRulesetRulesRequiredStatusChecksOutputReference + +--- + +##### `requiredWorkflows`Required + +```java +public OrganizationRulesetRulesRequiredWorkflowsOutputReference getRequiredWorkflows(); +``` + +- *Type:* OrganizationRulesetRulesRequiredWorkflowsOutputReference + +--- + +##### `tagNamePattern`Required + +```java +public OrganizationRulesetRulesTagNamePatternOutputReference getTagNamePattern(); +``` + +- *Type:* OrganizationRulesetRulesTagNamePatternOutputReference + +--- + +##### `branchNamePatternInput`Optional + +```java +public OrganizationRulesetRulesBranchNamePattern getBranchNamePatternInput(); +``` + +- *Type:* OrganizationRulesetRulesBranchNamePattern + +--- + +##### `commitAuthorEmailPatternInput`Optional + +```java +public OrganizationRulesetRulesCommitAuthorEmailPattern getCommitAuthorEmailPatternInput(); +``` + +- *Type:* OrganizationRulesetRulesCommitAuthorEmailPattern + +--- + +##### `commitMessagePatternInput`Optional + +```java +public OrganizationRulesetRulesCommitMessagePattern getCommitMessagePatternInput(); +``` + +- *Type:* OrganizationRulesetRulesCommitMessagePattern + +--- + +##### `committerEmailPatternInput`Optional + +```java +public OrganizationRulesetRulesCommitterEmailPattern getCommitterEmailPatternInput(); +``` + +- *Type:* OrganizationRulesetRulesCommitterEmailPattern + +--- + +##### `copilotCodeReviewInput`Optional + +```java +public OrganizationRulesetRulesCopilotCodeReview getCopilotCodeReviewInput(); +``` + +- *Type:* OrganizationRulesetRulesCopilotCodeReview + +--- + +##### `creationInput`Optional + +```java +public java.lang.Boolean|IResolvable getCreationInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `deletionInput`Optional + +```java +public java.lang.Boolean|IResolvable getDeletionInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `fileExtensionRestrictionInput`Optional + +```java +public OrganizationRulesetRulesFileExtensionRestriction getFileExtensionRestrictionInput(); +``` + +- *Type:* OrganizationRulesetRulesFileExtensionRestriction + +--- + +##### `filePathRestrictionInput`Optional + +```java +public OrganizationRulesetRulesFilePathRestriction getFilePathRestrictionInput(); +``` + +- *Type:* OrganizationRulesetRulesFilePathRestriction + +--- + +##### `maxFilePathLengthInput`Optional + +```java +public OrganizationRulesetRulesMaxFilePathLength getMaxFilePathLengthInput(); +``` + +- *Type:* OrganizationRulesetRulesMaxFilePathLength + +--- + +##### `maxFileSizeInput`Optional + +```java +public OrganizationRulesetRulesMaxFileSize getMaxFileSizeInput(); +``` + +- *Type:* OrganizationRulesetRulesMaxFileSize + +--- + +##### `nonFastForwardInput`Optional + +```java +public java.lang.Boolean|IResolvable getNonFastForwardInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `pullRequestInput`Optional + +```java +public OrganizationRulesetRulesPullRequest getPullRequestInput(); +``` + +- *Type:* OrganizationRulesetRulesPullRequest + +--- + +##### `requiredCodeScanningInput`Optional + +```java +public OrganizationRulesetRulesRequiredCodeScanning getRequiredCodeScanningInput(); +``` + +- *Type:* OrganizationRulesetRulesRequiredCodeScanning + +--- + +##### `requiredLinearHistoryInput`Optional + +```java +public java.lang.Boolean|IResolvable getRequiredLinearHistoryInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requiredSignaturesInput`Optional + +```java +public java.lang.Boolean|IResolvable getRequiredSignaturesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requiredStatusChecksInput`Optional + +```java +public OrganizationRulesetRulesRequiredStatusChecks getRequiredStatusChecksInput(); +``` + +- *Type:* OrganizationRulesetRulesRequiredStatusChecks + +--- + +##### `requiredWorkflowsInput`Optional + +```java +public OrganizationRulesetRulesRequiredWorkflows getRequiredWorkflowsInput(); +``` + +- *Type:* OrganizationRulesetRulesRequiredWorkflows + +--- + +##### `tagNamePatternInput`Optional + +```java +public OrganizationRulesetRulesTagNamePattern getTagNamePatternInput(); +``` + +- *Type:* OrganizationRulesetRulesTagNamePattern + +--- + +##### `updateInput`Optional + +```java +public java.lang.Boolean|IResolvable getUpdateInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `creation`Required + +```java +public java.lang.Boolean|IResolvable getCreation(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `deletion`Required + +```java +public java.lang.Boolean|IResolvable getDeletion(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `nonFastForward`Required + +```java +public java.lang.Boolean|IResolvable getNonFastForward(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requiredLinearHistory`Required + +```java +public java.lang.Boolean|IResolvable getRequiredLinearHistory(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requiredSignatures`Required + +```java +public java.lang.Boolean|IResolvable getRequiredSignatures(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `update`Required + +```java +public java.lang.Boolean|IResolvable getUpdate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `internalValue`Optional + +```java +public OrganizationRulesetRules getInternalValue(); +``` + +- *Type:* OrganizationRulesetRules + +--- + + +### OrganizationRulesetRulesPullRequestOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesPullRequestOutputReference; + +new OrganizationRulesetRulesPullRequestOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| putRequiredReviewers | *No description.* | +| resetAllowedMergeMethods | *No description.* | +| resetDismissStaleReviewsOnPush | *No description.* | +| resetRequireCodeOwnerReview | *No description.* | +| resetRequiredApprovingReviewCount | *No description.* | +| resetRequiredReviewers | *No description.* | +| resetRequiredReviewThreadResolution | *No description.* | +| resetRequireLastPushApproval | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `putRequiredReviewers` + +```java +public void putRequiredReviewers(IResolvable|java.util.List value) +``` + +###### `value`Required + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetRulesPullRequestRequiredReviewers> + +--- + +##### `resetAllowedMergeMethods` + +```java +public void resetAllowedMergeMethods() +``` + +##### `resetDismissStaleReviewsOnPush` + +```java +public void resetDismissStaleReviewsOnPush() +``` + +##### `resetRequireCodeOwnerReview` + +```java +public void resetRequireCodeOwnerReview() +``` + +##### `resetRequiredApprovingReviewCount` + +```java +public void resetRequiredApprovingReviewCount() +``` + +##### `resetRequiredReviewers` + +```java +public void resetRequiredReviewers() +``` + +##### `resetRequiredReviewThreadResolution` + +```java +public void resetRequiredReviewThreadResolution() +``` + +##### `resetRequireLastPushApproval` + +```java +public void resetRequireLastPushApproval() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| requiredReviewers | OrganizationRulesetRulesPullRequestRequiredReviewersList | *No description.* | +| allowedMergeMethodsInput | java.util.List | *No description.* | +| dismissStaleReviewsOnPushInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requireCodeOwnerReviewInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requiredApprovingReviewCountInput | java.lang.Number | *No description.* | +| requiredReviewersInput | io.cdktn.cdktn.IResolvable\|java.util.List<OrganizationRulesetRulesPullRequestRequiredReviewers> | *No description.* | +| requiredReviewThreadResolutionInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requireLastPushApprovalInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| allowedMergeMethods | java.util.List | *No description.* | +| dismissStaleReviewsOnPush | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requireCodeOwnerReview | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requiredApprovingReviewCount | java.lang.Number | *No description.* | +| requiredReviewThreadResolution | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requireLastPushApproval | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| internalValue | OrganizationRulesetRulesPullRequest | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `requiredReviewers`Required + +```java +public OrganizationRulesetRulesPullRequestRequiredReviewersList getRequiredReviewers(); +``` + +- *Type:* OrganizationRulesetRulesPullRequestRequiredReviewersList + +--- + +##### `allowedMergeMethodsInput`Optional + +```java +public java.util.List getAllowedMergeMethodsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `dismissStaleReviewsOnPushInput`Optional + +```java +public java.lang.Boolean|IResolvable getDismissStaleReviewsOnPushInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requireCodeOwnerReviewInput`Optional + +```java +public java.lang.Boolean|IResolvable getRequireCodeOwnerReviewInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requiredApprovingReviewCountInput`Optional + +```java +public java.lang.Number getRequiredApprovingReviewCountInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `requiredReviewersInput`Optional + +```java +public IResolvable|java.util.List getRequiredReviewersInput(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetRulesPullRequestRequiredReviewers> + +--- + +##### `requiredReviewThreadResolutionInput`Optional + +```java +public java.lang.Boolean|IResolvable getRequiredReviewThreadResolutionInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requireLastPushApprovalInput`Optional + +```java +public java.lang.Boolean|IResolvable getRequireLastPushApprovalInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `allowedMergeMethods`Required + +```java +public java.util.List getAllowedMergeMethods(); +``` + +- *Type:* java.util.List + +--- + +##### `dismissStaleReviewsOnPush`Required + +```java +public java.lang.Boolean|IResolvable getDismissStaleReviewsOnPush(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requireCodeOwnerReview`Required + +```java +public java.lang.Boolean|IResolvable getRequireCodeOwnerReview(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requiredApprovingReviewCount`Required + +```java +public java.lang.Number getRequiredApprovingReviewCount(); +``` + +- *Type:* java.lang.Number + +--- + +##### `requiredReviewThreadResolution`Required + +```java +public java.lang.Boolean|IResolvable getRequiredReviewThreadResolution(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requireLastPushApproval`Required + +```java +public java.lang.Boolean|IResolvable getRequireLastPushApproval(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `internalValue`Optional + +```java +public OrganizationRulesetRulesPullRequest getInternalValue(); +``` + +- *Type:* OrganizationRulesetRulesPullRequest + +--- + + +### OrganizationRulesetRulesPullRequestRequiredReviewersList + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesPullRequestRequiredReviewersList; + +new OrganizationRulesetRulesPullRequestRequiredReviewersList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public OrganizationRulesetRulesPullRequestRequiredReviewersOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|java.util.List<OrganizationRulesetRulesPullRequestRequiredReviewers> | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|java.util.List getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetRulesPullRequestRequiredReviewers> + +--- + + +### OrganizationRulesetRulesPullRequestRequiredReviewersOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesPullRequestRequiredReviewersOutputReference; + +new OrganizationRulesetRulesPullRequestRequiredReviewersOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| putReviewer | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `putReviewer` + +```java +public void putReviewer(OrganizationRulesetRulesPullRequestRequiredReviewersReviewer value) +``` + +###### `value`Required + +- *Type:* OrganizationRulesetRulesPullRequestRequiredReviewersReviewer + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| reviewer | OrganizationRulesetRulesPullRequestRequiredReviewersReviewerOutputReference | *No description.* | +| filePatternsInput | java.util.List | *No description.* | +| minimumApprovalsInput | java.lang.Number | *No description.* | +| reviewerInput | OrganizationRulesetRulesPullRequestRequiredReviewersReviewer | *No description.* | +| filePatterns | java.util.List | *No description.* | +| minimumApprovals | java.lang.Number | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|OrganizationRulesetRulesPullRequestRequiredReviewers | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `reviewer`Required + +```java +public OrganizationRulesetRulesPullRequestRequiredReviewersReviewerOutputReference getReviewer(); +``` + +- *Type:* OrganizationRulesetRulesPullRequestRequiredReviewersReviewerOutputReference + +--- + +##### `filePatternsInput`Optional + +```java +public java.util.List getFilePatternsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `minimumApprovalsInput`Optional + +```java +public java.lang.Number getMinimumApprovalsInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `reviewerInput`Optional + +```java +public OrganizationRulesetRulesPullRequestRequiredReviewersReviewer getReviewerInput(); +``` + +- *Type:* OrganizationRulesetRulesPullRequestRequiredReviewersReviewer + +--- + +##### `filePatterns`Required + +```java +public java.util.List getFilePatterns(); +``` + +- *Type:* java.util.List + +--- + +##### `minimumApprovals`Required + +```java +public java.lang.Number getMinimumApprovals(); +``` + +- *Type:* java.lang.Number + +--- + +##### `internalValue`Optional + +```java +public IResolvable|OrganizationRulesetRulesPullRequestRequiredReviewers getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|OrganizationRulesetRulesPullRequestRequiredReviewers + +--- + + +### OrganizationRulesetRulesPullRequestRequiredReviewersReviewerOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesPullRequestRequiredReviewersReviewerOutputReference; + +new OrganizationRulesetRulesPullRequestRequiredReviewersReviewerOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| idInput | java.lang.Number | *No description.* | +| typeInput | java.lang.String | *No description.* | +| id | java.lang.Number | *No description.* | +| type | java.lang.String | *No description.* | +| internalValue | OrganizationRulesetRulesPullRequestRequiredReviewersReviewer | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.Number getIdInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `typeInput`Optional + +```java +public java.lang.String getTypeInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.Number getId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `type`Required + +```java +public java.lang.String getType(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public OrganizationRulesetRulesPullRequestRequiredReviewersReviewer getInternalValue(); +``` + +- *Type:* OrganizationRulesetRulesPullRequestRequiredReviewersReviewer + +--- + + +### OrganizationRulesetRulesRequiredCodeScanningOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesRequiredCodeScanningOutputReference; + +new OrganizationRulesetRulesRequiredCodeScanningOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| putRequiredCodeScanningTool | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `putRequiredCodeScanningTool` + +```java +public void putRequiredCodeScanningTool(IResolvable|java.util.List value) +``` + +###### `value`Required + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool> + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| requiredCodeScanningTool | OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningToolList | *No description.* | +| requiredCodeScanningToolInput | io.cdktn.cdktn.IResolvable\|java.util.List<OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool> | *No description.* | +| internalValue | OrganizationRulesetRulesRequiredCodeScanning | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `requiredCodeScanningTool`Required + +```java +public OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningToolList getRequiredCodeScanningTool(); +``` + +- *Type:* OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningToolList + +--- + +##### `requiredCodeScanningToolInput`Optional + +```java +public IResolvable|java.util.List getRequiredCodeScanningToolInput(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool> + +--- + +##### `internalValue`Optional + +```java +public OrganizationRulesetRulesRequiredCodeScanning getInternalValue(); +``` + +- *Type:* OrganizationRulesetRulesRequiredCodeScanning + +--- + + +### OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningToolList + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningToolList; + +new OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningToolList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningToolOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|java.util.List<OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool> | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|java.util.List getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool> + +--- + + +### OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningToolOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningToolOutputReference; + +new OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningToolOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| alertsThresholdInput | java.lang.String | *No description.* | +| securityAlertsThresholdInput | java.lang.String | *No description.* | +| toolInput | java.lang.String | *No description.* | +| alertsThreshold | java.lang.String | *No description.* | +| securityAlertsThreshold | java.lang.String | *No description.* | +| tool | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `alertsThresholdInput`Optional + +```java +public java.lang.String getAlertsThresholdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `securityAlertsThresholdInput`Optional + +```java +public java.lang.String getSecurityAlertsThresholdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `toolInput`Optional + +```java +public java.lang.String getToolInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `alertsThreshold`Required + +```java +public java.lang.String getAlertsThreshold(); +``` + +- *Type:* java.lang.String + +--- + +##### `securityAlertsThreshold`Required + +```java +public java.lang.String getSecurityAlertsThreshold(); +``` + +- *Type:* java.lang.String + +--- + +##### `tool`Required + +```java +public java.lang.String getTool(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool + +--- + + +### OrganizationRulesetRulesRequiredStatusChecksOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesRequiredStatusChecksOutputReference; + +new OrganizationRulesetRulesRequiredStatusChecksOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| putRequiredCheck | *No description.* | +| resetDoNotEnforceOnCreate | *No description.* | +| resetStrictRequiredStatusChecksPolicy | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `putRequiredCheck` + +```java +public void putRequiredCheck(IResolvable|java.util.List value) +``` + +###### `value`Required + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetRulesRequiredStatusChecksRequiredCheck> + +--- + +##### `resetDoNotEnforceOnCreate` + +```java +public void resetDoNotEnforceOnCreate() +``` + +##### `resetStrictRequiredStatusChecksPolicy` + +```java +public void resetStrictRequiredStatusChecksPolicy() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| requiredCheck | OrganizationRulesetRulesRequiredStatusChecksRequiredCheckList | *No description.* | +| doNotEnforceOnCreateInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requiredCheckInput | io.cdktn.cdktn.IResolvable\|java.util.List<OrganizationRulesetRulesRequiredStatusChecksRequiredCheck> | *No description.* | +| strictRequiredStatusChecksPolicyInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| doNotEnforceOnCreate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| strictRequiredStatusChecksPolicy | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| internalValue | OrganizationRulesetRulesRequiredStatusChecks | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `requiredCheck`Required + +```java +public OrganizationRulesetRulesRequiredStatusChecksRequiredCheckList getRequiredCheck(); +``` + +- *Type:* OrganizationRulesetRulesRequiredStatusChecksRequiredCheckList + +--- + +##### `doNotEnforceOnCreateInput`Optional + +```java +public java.lang.Boolean|IResolvable getDoNotEnforceOnCreateInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requiredCheckInput`Optional + +```java +public IResolvable|java.util.List getRequiredCheckInput(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetRulesRequiredStatusChecksRequiredCheck> + +--- + +##### `strictRequiredStatusChecksPolicyInput`Optional + +```java +public java.lang.Boolean|IResolvable getStrictRequiredStatusChecksPolicyInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `doNotEnforceOnCreate`Required + +```java +public java.lang.Boolean|IResolvable getDoNotEnforceOnCreate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `strictRequiredStatusChecksPolicy`Required + +```java +public java.lang.Boolean|IResolvable getStrictRequiredStatusChecksPolicy(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `internalValue`Optional + +```java +public OrganizationRulesetRulesRequiredStatusChecks getInternalValue(); +``` + +- *Type:* OrganizationRulesetRulesRequiredStatusChecks + +--- + + +### OrganizationRulesetRulesRequiredStatusChecksRequiredCheckList + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesRequiredStatusChecksRequiredCheckList; + +new OrganizationRulesetRulesRequiredStatusChecksRequiredCheckList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public OrganizationRulesetRulesRequiredStatusChecksRequiredCheckOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|java.util.List<OrganizationRulesetRulesRequiredStatusChecksRequiredCheck> | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|java.util.List getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetRulesRequiredStatusChecksRequiredCheck> + +--- + + +### OrganizationRulesetRulesRequiredStatusChecksRequiredCheckOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesRequiredStatusChecksRequiredCheckOutputReference; + +new OrganizationRulesetRulesRequiredStatusChecksRequiredCheckOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetIntegrationId | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetIntegrationId` + +```java +public void resetIntegrationId() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| contextInput | java.lang.String | *No description.* | +| integrationIdInput | java.lang.Number | *No description.* | +| context | java.lang.String | *No description.* | +| integrationId | java.lang.Number | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|OrganizationRulesetRulesRequiredStatusChecksRequiredCheck | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `contextInput`Optional + +```java +public java.lang.String getContextInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `integrationIdInput`Optional + +```java +public java.lang.Number getIntegrationIdInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `context`Required + +```java +public java.lang.String getContext(); +``` + +- *Type:* java.lang.String + +--- + +##### `integrationId`Required + +```java +public java.lang.Number getIntegrationId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `internalValue`Optional + +```java +public IResolvable|OrganizationRulesetRulesRequiredStatusChecksRequiredCheck getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|OrganizationRulesetRulesRequiredStatusChecksRequiredCheck + +--- + + +### OrganizationRulesetRulesRequiredWorkflowsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesRequiredWorkflowsOutputReference; + +new OrganizationRulesetRulesRequiredWorkflowsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| putRequiredWorkflow | *No description.* | +| resetDoNotEnforceOnCreate | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `putRequiredWorkflow` + +```java +public void putRequiredWorkflow(IResolvable|java.util.List value) +``` + +###### `value`Required + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow> + +--- + +##### `resetDoNotEnforceOnCreate` + +```java +public void resetDoNotEnforceOnCreate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| requiredWorkflow | OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflowList | *No description.* | +| doNotEnforceOnCreateInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requiredWorkflowInput | io.cdktn.cdktn.IResolvable\|java.util.List<OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow> | *No description.* | +| doNotEnforceOnCreate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| internalValue | OrganizationRulesetRulesRequiredWorkflows | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `requiredWorkflow`Required + +```java +public OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflowList getRequiredWorkflow(); +``` + +- *Type:* OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflowList + +--- + +##### `doNotEnforceOnCreateInput`Optional + +```java +public java.lang.Boolean|IResolvable getDoNotEnforceOnCreateInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requiredWorkflowInput`Optional + +```java +public IResolvable|java.util.List getRequiredWorkflowInput(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow> + +--- + +##### `doNotEnforceOnCreate`Required + +```java +public java.lang.Boolean|IResolvable getDoNotEnforceOnCreate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `internalValue`Optional + +```java +public OrganizationRulesetRulesRequiredWorkflows getInternalValue(); +``` + +- *Type:* OrganizationRulesetRulesRequiredWorkflows + +--- + + +### OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflowList + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflowList; + +new OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflowList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflowOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|java.util.List<OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow> | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|java.util.List getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow> + +--- + + +### OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflowOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflowOutputReference; + +new OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflowOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetRef | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetRef` + +```java +public void resetRef() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| pathInput | java.lang.String | *No description.* | +| refInput | java.lang.String | *No description.* | +| repositoryIdInput | java.lang.Number | *No description.* | +| path | java.lang.String | *No description.* | +| ref | java.lang.String | *No description.* | +| repositoryId | java.lang.Number | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `pathInput`Optional + +```java +public java.lang.String getPathInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `refInput`Optional + +```java +public java.lang.String getRefInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryIdInput`Optional + +```java +public java.lang.Number getRepositoryIdInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `path`Required + +```java +public java.lang.String getPath(); +``` + +- *Type:* java.lang.String + +--- + +##### `ref`Required + +```java +public java.lang.String getRef(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryId`Required + +```java +public java.lang.Number getRepositoryId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `internalValue`Optional + +```java +public IResolvable|OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow + +--- + + +### OrganizationRulesetRulesTagNamePatternOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_ruleset.OrganizationRulesetRulesTagNamePatternOutputReference; + +new OrganizationRulesetRulesTagNamePatternOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetName | *No description.* | +| resetNegate | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetName` + +```java +public void resetName() +``` + +##### `resetNegate` + +```java +public void resetNegate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| negateInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| operatorInput | java.lang.String | *No description.* | +| patternInput | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| negate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| operator | java.lang.String | *No description.* | +| pattern | java.lang.String | *No description.* | +| internalValue | OrganizationRulesetRulesTagNamePattern | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `negateInput`Optional + +```java +public java.lang.Boolean|IResolvable getNegateInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `operatorInput`Optional + +```java +public java.lang.String getOperatorInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `patternInput`Optional + +```java +public java.lang.String getPatternInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `negate`Required + +```java +public java.lang.Boolean|IResolvable getNegate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `operator`Required + +```java +public java.lang.String getOperator(); +``` + +- *Type:* java.lang.String + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public OrganizationRulesetRulesTagNamePattern getInternalValue(); +``` + +- *Type:* OrganizationRulesetRulesTagNamePattern + +--- + + + diff --git a/docs/organizationSecurityManager.csharp.md b/docs/organizationSecurityManager.csharp.md new file mode 100644 index 000000000..80596786b --- /dev/null +++ b/docs/organizationSecurityManager.csharp.md @@ -0,0 +1,874 @@ +# `organizationSecurityManager` Submodule + +## Constructs + +### OrganizationSecurityManager + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_security_manager github_organization_security_manager}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationSecurityManager(Construct Scope, string Id, OrganizationSecurityManagerConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | OrganizationSecurityManagerConfig | *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:* OrganizationSecurityManagerConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a OrganizationSecurityManager resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationSecurityManager.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` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationSecurityManager.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationSecurityManager.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationSecurityManager.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a OrganizationSecurityManager resource upon running "cdktn 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 OrganizationSecurityManager to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing OrganizationSecurityManager that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_security_manager#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the OrganizationSecurityManager to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| IdInput | string | *No description.* | +| TeamSlugInput | string | *No description.* | +| Id | string | *No description.* | +| TeamSlug | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `TeamSlugInput`Optional + +```csharp +public string TeamSlugInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `TeamSlug`Required + +```csharp +public string TeamSlug { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### OrganizationSecurityManagerConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationSecurityManagerConfig { + 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 TeamSlug, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| TeamSlug | string | The slug of the team to manage. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_security_manager#id OrganizationSecurityManager#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `TeamSlug`Required + +```csharp +public string TeamSlug { get; set; } +``` + +- *Type:* string + +The slug of the team to manage. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_security_manager#team_slug OrganizationSecurityManager#team_slug} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_security_manager#id OrganizationSecurityManager#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. + +--- + + + diff --git a/docs/organizationSecurityManager.java.md b/docs/organizationSecurityManager.java.md new file mode 100644 index 000000000..b08cbea88 --- /dev/null +++ b/docs/organizationSecurityManager.java.md @@ -0,0 +1,951 @@ +# `organizationSecurityManager` Submodule + +## Constructs + +### OrganizationSecurityManager + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_security_manager github_organization_security_manager}. + +#### Initializers + +```java +import io.cdktn.providers.github.organization_security_manager.OrganizationSecurityManager; + +OrganizationSecurityManager.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .teamSlug(java.lang.String) +// .id(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 | *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 | *No description.* | +| teamSlug | java.lang.String | The slug of the team to manage. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_security_manager#id OrganizationSecurityManager#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `teamSlug`Required + +- *Type:* java.lang.String + +The slug of the team to manage. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_security_manager#team_slug OrganizationSecurityManager#team_slug} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_security_manager#id OrganizationSecurityManager#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a OrganizationSecurityManager resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.organization_security_manager.OrganizationSecurityManager; + +OrganizationSecurityManager.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` + +```java +import io.cdktn.providers.github.organization_security_manager.OrganizationSecurityManager; + +OrganizationSecurityManager.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.organization_security_manager.OrganizationSecurityManager; + +OrganizationSecurityManager.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.organization_security_manager.OrganizationSecurityManager; + +OrganizationSecurityManager.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),OrganizationSecurityManager.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a OrganizationSecurityManager 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 OrganizationSecurityManager to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing OrganizationSecurityManager that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_security_manager#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 OrganizationSecurityManager 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| idInput | java.lang.String | *No description.* | +| teamSlugInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| teamSlug | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `teamSlugInput`Optional + +```java +public java.lang.String getTeamSlugInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `teamSlug`Required + +```java +public java.lang.String getTeamSlug(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### OrganizationSecurityManagerConfig + +#### Initializer + +```java +import io.cdktn.providers.github.organization_security_manager.OrganizationSecurityManagerConfig; + +OrganizationSecurityManagerConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .teamSlug(java.lang.String) +// .id(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 | *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 | *No description.* | +| teamSlug | java.lang.String | The slug of the team to manage. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_security_manager#id OrganizationSecurityManager#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `teamSlug`Required + +```java +public java.lang.String getTeamSlug(); +``` + +- *Type:* java.lang.String + +The slug of the team to manage. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_security_manager#team_slug OrganizationSecurityManager#team_slug} + +--- + +##### `id`Optional + +```java +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/resources/organization_security_manager#id OrganizationSecurityManager#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. + +--- + + + diff --git a/docs/organizationSettings.csharp.md b/docs/organizationSettings.csharp.md new file mode 100644 index 000000000..9c29e75aa --- /dev/null +++ b/docs/organizationSettings.csharp.md @@ -0,0 +1,1999 @@ +# `organizationSettings` Submodule + +## Constructs + +### OrganizationSettings + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings github_organization_settings}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationSettings(Construct Scope, string Id, OrganizationSettingsConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | OrganizationSettingsConfig | *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:* OrganizationSettingsConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetAdvancedSecurityEnabledForNewRepositories | *No description.* | +| ResetBlog | *No description.* | +| ResetCompany | *No description.* | +| ResetDefaultRepositoryPermission | *No description.* | +| ResetDependabotAlertsEnabledForNewRepositories | *No description.* | +| ResetDependabotSecurityUpdatesEnabledForNewRepositories | *No description.* | +| ResetDependencyGraphEnabledForNewRepositories | *No description.* | +| ResetDescription | *No description.* | +| ResetEmail | *No description.* | +| ResetHasOrganizationProjects | *No description.* | +| ResetHasRepositoryProjects | *No description.* | +| ResetId | *No description.* | +| ResetLocation | *No description.* | +| ResetMembersCanCreateInternalRepositories | *No description.* | +| ResetMembersCanCreatePages | *No description.* | +| ResetMembersCanCreatePrivatePages | *No description.* | +| ResetMembersCanCreatePrivateRepositories | *No description.* | +| ResetMembersCanCreatePublicPages | *No description.* | +| ResetMembersCanCreatePublicRepositories | *No description.* | +| ResetMembersCanCreateRepositories | *No description.* | +| ResetMembersCanForkPrivateRepositories | *No description.* | +| ResetName | *No description.* | +| ResetSecretScanningEnabledForNewRepositories | *No description.* | +| ResetSecretScanningPushProtectionEnabledForNewRepositories | *No description.* | +| ResetTwitterUsername | *No description.* | +| ResetWebCommitSignoffRequired | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetAdvancedSecurityEnabledForNewRepositories` + +```csharp +private void ResetAdvancedSecurityEnabledForNewRepositories() +``` + +##### `ResetBlog` + +```csharp +private void ResetBlog() +``` + +##### `ResetCompany` + +```csharp +private void ResetCompany() +``` + +##### `ResetDefaultRepositoryPermission` + +```csharp +private void ResetDefaultRepositoryPermission() +``` + +##### `ResetDependabotAlertsEnabledForNewRepositories` + +```csharp +private void ResetDependabotAlertsEnabledForNewRepositories() +``` + +##### `ResetDependabotSecurityUpdatesEnabledForNewRepositories` + +```csharp +private void ResetDependabotSecurityUpdatesEnabledForNewRepositories() +``` + +##### `ResetDependencyGraphEnabledForNewRepositories` + +```csharp +private void ResetDependencyGraphEnabledForNewRepositories() +``` + +##### `ResetDescription` + +```csharp +private void ResetDescription() +``` + +##### `ResetEmail` + +```csharp +private void ResetEmail() +``` + +##### `ResetHasOrganizationProjects` + +```csharp +private void ResetHasOrganizationProjects() +``` + +##### `ResetHasRepositoryProjects` + +```csharp +private void ResetHasRepositoryProjects() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetLocation` + +```csharp +private void ResetLocation() +``` + +##### `ResetMembersCanCreateInternalRepositories` + +```csharp +private void ResetMembersCanCreateInternalRepositories() +``` + +##### `ResetMembersCanCreatePages` + +```csharp +private void ResetMembersCanCreatePages() +``` + +##### `ResetMembersCanCreatePrivatePages` + +```csharp +private void ResetMembersCanCreatePrivatePages() +``` + +##### `ResetMembersCanCreatePrivateRepositories` + +```csharp +private void ResetMembersCanCreatePrivateRepositories() +``` + +##### `ResetMembersCanCreatePublicPages` + +```csharp +private void ResetMembersCanCreatePublicPages() +``` + +##### `ResetMembersCanCreatePublicRepositories` + +```csharp +private void ResetMembersCanCreatePublicRepositories() +``` + +##### `ResetMembersCanCreateRepositories` + +```csharp +private void ResetMembersCanCreateRepositories() +``` + +##### `ResetMembersCanForkPrivateRepositories` + +```csharp +private void ResetMembersCanForkPrivateRepositories() +``` + +##### `ResetName` + +```csharp +private void ResetName() +``` + +##### `ResetSecretScanningEnabledForNewRepositories` + +```csharp +private void ResetSecretScanningEnabledForNewRepositories() +``` + +##### `ResetSecretScanningPushProtectionEnabledForNewRepositories` + +```csharp +private void ResetSecretScanningPushProtectionEnabledForNewRepositories() +``` + +##### `ResetTwitterUsername` + +```csharp +private void ResetTwitterUsername() +``` + +##### `ResetWebCommitSignoffRequired` + +```csharp +private void ResetWebCommitSignoffRequired() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a OrganizationSettings resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationSettings.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` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationSettings.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationSettings.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationSettings.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a OrganizationSettings resource upon running "cdktn 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 OrganizationSettings to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing OrganizationSettings that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the OrganizationSettings to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| AdvancedSecurityEnabledForNewRepositoriesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| BillingEmailInput | string | *No description.* | +| BlogInput | string | *No description.* | +| CompanyInput | string | *No description.* | +| DefaultRepositoryPermissionInput | string | *No description.* | +| DependabotAlertsEnabledForNewRepositoriesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| DependabotSecurityUpdatesEnabledForNewRepositoriesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| DependencyGraphEnabledForNewRepositoriesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| DescriptionInput | string | *No description.* | +| EmailInput | string | *No description.* | +| HasOrganizationProjectsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| HasRepositoryProjectsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| IdInput | string | *No description.* | +| LocationInput | string | *No description.* | +| MembersCanCreateInternalRepositoriesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| MembersCanCreatePagesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| MembersCanCreatePrivatePagesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| MembersCanCreatePrivateRepositoriesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| MembersCanCreatePublicPagesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| MembersCanCreatePublicRepositoriesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| MembersCanCreateRepositoriesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| MembersCanForkPrivateRepositoriesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| NameInput | string | *No description.* | +| SecretScanningEnabledForNewRepositoriesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| SecretScanningPushProtectionEnabledForNewRepositoriesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| TwitterUsernameInput | string | *No description.* | +| WebCommitSignoffRequiredInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| AdvancedSecurityEnabledForNewRepositories | bool\|Io.Cdktn.IResolvable | *No description.* | +| BillingEmail | string | *No description.* | +| Blog | string | *No description.* | +| Company | string | *No description.* | +| DefaultRepositoryPermission | string | *No description.* | +| DependabotAlertsEnabledForNewRepositories | bool\|Io.Cdktn.IResolvable | *No description.* | +| DependabotSecurityUpdatesEnabledForNewRepositories | bool\|Io.Cdktn.IResolvable | *No description.* | +| DependencyGraphEnabledForNewRepositories | bool\|Io.Cdktn.IResolvable | *No description.* | +| Description | string | *No description.* | +| Email | string | *No description.* | +| HasOrganizationProjects | bool\|Io.Cdktn.IResolvable | *No description.* | +| HasRepositoryProjects | bool\|Io.Cdktn.IResolvable | *No description.* | +| Id | string | *No description.* | +| Location | string | *No description.* | +| MembersCanCreateInternalRepositories | bool\|Io.Cdktn.IResolvable | *No description.* | +| MembersCanCreatePages | bool\|Io.Cdktn.IResolvable | *No description.* | +| MembersCanCreatePrivatePages | bool\|Io.Cdktn.IResolvable | *No description.* | +| MembersCanCreatePrivateRepositories | bool\|Io.Cdktn.IResolvable | *No description.* | +| MembersCanCreatePublicPages | bool\|Io.Cdktn.IResolvable | *No description.* | +| MembersCanCreatePublicRepositories | bool\|Io.Cdktn.IResolvable | *No description.* | +| MembersCanCreateRepositories | bool\|Io.Cdktn.IResolvable | *No description.* | +| MembersCanForkPrivateRepositories | bool\|Io.Cdktn.IResolvable | *No description.* | +| Name | string | *No description.* | +| SecretScanningEnabledForNewRepositories | bool\|Io.Cdktn.IResolvable | *No description.* | +| SecretScanningPushProtectionEnabledForNewRepositories | bool\|Io.Cdktn.IResolvable | *No description.* | +| TwitterUsername | string | *No description.* | +| WebCommitSignoffRequired | bool\|Io.Cdktn.IResolvable | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `AdvancedSecurityEnabledForNewRepositoriesInput`Optional + +```csharp +public bool|IResolvable AdvancedSecurityEnabledForNewRepositoriesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `BillingEmailInput`Optional + +```csharp +public string BillingEmailInput { get; } +``` + +- *Type:* string + +--- + +##### `BlogInput`Optional + +```csharp +public string BlogInput { get; } +``` + +- *Type:* string + +--- + +##### `CompanyInput`Optional + +```csharp +public string CompanyInput { get; } +``` + +- *Type:* string + +--- + +##### `DefaultRepositoryPermissionInput`Optional + +```csharp +public string DefaultRepositoryPermissionInput { get; } +``` + +- *Type:* string + +--- + +##### `DependabotAlertsEnabledForNewRepositoriesInput`Optional + +```csharp +public bool|IResolvable DependabotAlertsEnabledForNewRepositoriesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `DependabotSecurityUpdatesEnabledForNewRepositoriesInput`Optional + +```csharp +public bool|IResolvable DependabotSecurityUpdatesEnabledForNewRepositoriesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `DependencyGraphEnabledForNewRepositoriesInput`Optional + +```csharp +public bool|IResolvable DependencyGraphEnabledForNewRepositoriesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `DescriptionInput`Optional + +```csharp +public string DescriptionInput { get; } +``` + +- *Type:* string + +--- + +##### `EmailInput`Optional + +```csharp +public string EmailInput { get; } +``` + +- *Type:* string + +--- + +##### `HasOrganizationProjectsInput`Optional + +```csharp +public bool|IResolvable HasOrganizationProjectsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `HasRepositoryProjectsInput`Optional + +```csharp +public bool|IResolvable HasRepositoryProjectsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `LocationInput`Optional + +```csharp +public string LocationInput { get; } +``` + +- *Type:* string + +--- + +##### `MembersCanCreateInternalRepositoriesInput`Optional + +```csharp +public bool|IResolvable MembersCanCreateInternalRepositoriesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `MembersCanCreatePagesInput`Optional + +```csharp +public bool|IResolvable MembersCanCreatePagesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `MembersCanCreatePrivatePagesInput`Optional + +```csharp +public bool|IResolvable MembersCanCreatePrivatePagesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `MembersCanCreatePrivateRepositoriesInput`Optional + +```csharp +public bool|IResolvable MembersCanCreatePrivateRepositoriesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `MembersCanCreatePublicPagesInput`Optional + +```csharp +public bool|IResolvable MembersCanCreatePublicPagesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `MembersCanCreatePublicRepositoriesInput`Optional + +```csharp +public bool|IResolvable MembersCanCreatePublicRepositoriesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `MembersCanCreateRepositoriesInput`Optional + +```csharp +public bool|IResolvable MembersCanCreateRepositoriesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `MembersCanForkPrivateRepositoriesInput`Optional + +```csharp +public bool|IResolvable MembersCanForkPrivateRepositoriesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `SecretScanningEnabledForNewRepositoriesInput`Optional + +```csharp +public bool|IResolvable SecretScanningEnabledForNewRepositoriesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `SecretScanningPushProtectionEnabledForNewRepositoriesInput`Optional + +```csharp +public bool|IResolvable SecretScanningPushProtectionEnabledForNewRepositoriesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `TwitterUsernameInput`Optional + +```csharp +public string TwitterUsernameInput { get; } +``` + +- *Type:* string + +--- + +##### `WebCommitSignoffRequiredInput`Optional + +```csharp +public bool|IResolvable WebCommitSignoffRequiredInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `AdvancedSecurityEnabledForNewRepositories`Required + +```csharp +public bool|IResolvable AdvancedSecurityEnabledForNewRepositories { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `BillingEmail`Required + +```csharp +public string BillingEmail { get; } +``` + +- *Type:* string + +--- + +##### `Blog`Required + +```csharp +public string Blog { get; } +``` + +- *Type:* string + +--- + +##### `Company`Required + +```csharp +public string Company { get; } +``` + +- *Type:* string + +--- + +##### `DefaultRepositoryPermission`Required + +```csharp +public string DefaultRepositoryPermission { get; } +``` + +- *Type:* string + +--- + +##### `DependabotAlertsEnabledForNewRepositories`Required + +```csharp +public bool|IResolvable DependabotAlertsEnabledForNewRepositories { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `DependabotSecurityUpdatesEnabledForNewRepositories`Required + +```csharp +public bool|IResolvable DependabotSecurityUpdatesEnabledForNewRepositories { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `DependencyGraphEnabledForNewRepositories`Required + +```csharp +public bool|IResolvable DependencyGraphEnabledForNewRepositories { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `Email`Required + +```csharp +public string Email { get; } +``` + +- *Type:* string + +--- + +##### `HasOrganizationProjects`Required + +```csharp +public bool|IResolvable HasOrganizationProjects { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `HasRepositoryProjects`Required + +```csharp +public bool|IResolvable HasRepositoryProjects { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Location`Required + +```csharp +public string Location { get; } +``` + +- *Type:* string + +--- + +##### `MembersCanCreateInternalRepositories`Required + +```csharp +public bool|IResolvable MembersCanCreateInternalRepositories { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `MembersCanCreatePages`Required + +```csharp +public bool|IResolvable MembersCanCreatePages { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `MembersCanCreatePrivatePages`Required + +```csharp +public bool|IResolvable MembersCanCreatePrivatePages { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `MembersCanCreatePrivateRepositories`Required + +```csharp +public bool|IResolvable MembersCanCreatePrivateRepositories { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `MembersCanCreatePublicPages`Required + +```csharp +public bool|IResolvable MembersCanCreatePublicPages { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `MembersCanCreatePublicRepositories`Required + +```csharp +public bool|IResolvable MembersCanCreatePublicRepositories { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `MembersCanCreateRepositories`Required + +```csharp +public bool|IResolvable MembersCanCreateRepositories { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `MembersCanForkPrivateRepositories`Required + +```csharp +public bool|IResolvable MembersCanForkPrivateRepositories { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `SecretScanningEnabledForNewRepositories`Required + +```csharp +public bool|IResolvable SecretScanningEnabledForNewRepositories { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `SecretScanningPushProtectionEnabledForNewRepositories`Required + +```csharp +public bool|IResolvable SecretScanningPushProtectionEnabledForNewRepositories { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `TwitterUsername`Required + +```csharp +public string TwitterUsername { get; } +``` + +- *Type:* string + +--- + +##### `WebCommitSignoffRequired`Required + +```csharp +public bool|IResolvable WebCommitSignoffRequired { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### OrganizationSettingsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationSettingsConfig { + 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 BillingEmail, + bool|IResolvable AdvancedSecurityEnabledForNewRepositories = null, + string Blog = null, + string Company = null, + string DefaultRepositoryPermission = null, + bool|IResolvable DependabotAlertsEnabledForNewRepositories = null, + bool|IResolvable DependabotSecurityUpdatesEnabledForNewRepositories = null, + bool|IResolvable DependencyGraphEnabledForNewRepositories = null, + string Description = null, + string Email = null, + bool|IResolvable HasOrganizationProjects = null, + bool|IResolvable HasRepositoryProjects = null, + string Id = null, + string Location = null, + bool|IResolvable MembersCanCreateInternalRepositories = null, + bool|IResolvable MembersCanCreatePages = null, + bool|IResolvable MembersCanCreatePrivatePages = null, + bool|IResolvable MembersCanCreatePrivateRepositories = null, + bool|IResolvable MembersCanCreatePublicPages = null, + bool|IResolvable MembersCanCreatePublicRepositories = null, + bool|IResolvable MembersCanCreateRepositories = null, + bool|IResolvable MembersCanForkPrivateRepositories = null, + string Name = null, + bool|IResolvable SecretScanningEnabledForNewRepositories = null, + bool|IResolvable SecretScanningPushProtectionEnabledForNewRepositories = null, + string TwitterUsername = null, + bool|IResolvable WebCommitSignoffRequired = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| BillingEmail | string | The billing email address for the organization. | +| AdvancedSecurityEnabledForNewRepositories | bool\|Io.Cdktn.IResolvable | Whether or not advanced security is enabled for new repositories. | +| Blog | string | The blog URL for the organization. | +| Company | string | The company name for the organization. | +| DefaultRepositoryPermission | string | The default permission for organization members to create new repositories. Can be one of 'read', 'write', 'admin' or 'none'. | +| DependabotAlertsEnabledForNewRepositories | bool\|Io.Cdktn.IResolvable | Whether or not dependabot alerts are enabled for new repositories. | +| DependabotSecurityUpdatesEnabledForNewRepositories | bool\|Io.Cdktn.IResolvable | Whether or not dependabot security updates are enabled for new repositories. | +| DependencyGraphEnabledForNewRepositories | bool\|Io.Cdktn.IResolvable | Whether or not dependency graph is enabled for new repositories. | +| Description | string | The description for the organization. | +| Email | string | The email address for the organization. | +| HasOrganizationProjects | bool\|Io.Cdktn.IResolvable | Whether or not organization projects are enabled for the organization. | +| HasRepositoryProjects | bool\|Io.Cdktn.IResolvable | Whether or not repository projects are enabled for the organization. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#id OrganizationSettings#id}. | +| Location | string | The location for the organization. | +| MembersCanCreateInternalRepositories | bool\|Io.Cdktn.IResolvable | Whether or not organization members can create new internal repositories. For Enterprise Organizations only. | +| MembersCanCreatePages | bool\|Io.Cdktn.IResolvable | Whether or not organization members can create new pages. | +| MembersCanCreatePrivatePages | bool\|Io.Cdktn.IResolvable | Whether or not organization members can create new private pages. | +| MembersCanCreatePrivateRepositories | bool\|Io.Cdktn.IResolvable | Whether or not organization members can create new private repositories. | +| MembersCanCreatePublicPages | bool\|Io.Cdktn.IResolvable | Whether or not organization members can create new public pages. | +| MembersCanCreatePublicRepositories | bool\|Io.Cdktn.IResolvable | Whether or not organization members can create new public repositories. | +| MembersCanCreateRepositories | bool\|Io.Cdktn.IResolvable | Whether or not organization members can create new repositories. | +| MembersCanForkPrivateRepositories | bool\|Io.Cdktn.IResolvable | Whether or not organization members can fork private repositories. | +| Name | string | The name for the organization. | +| SecretScanningEnabledForNewRepositories | bool\|Io.Cdktn.IResolvable | Whether or not secret scanning is enabled for new repositories. | +| SecretScanningPushProtectionEnabledForNewRepositories | bool\|Io.Cdktn.IResolvable | Whether or not secret scanning push protection is enabled for new repositories. | +| TwitterUsername | string | The Twitter username for the organization. | +| WebCommitSignoffRequired | bool\|Io.Cdktn.IResolvable | Whether or not commit signatures are required for commits to the organization. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `BillingEmail`Required + +```csharp +public string BillingEmail { get; set; } +``` + +- *Type:* string + +The billing email address for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#billing_email OrganizationSettings#billing_email} + +--- + +##### `AdvancedSecurityEnabledForNewRepositories`Optional + +```csharp +public bool|IResolvable AdvancedSecurityEnabledForNewRepositories { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether or not advanced security is enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#advanced_security_enabled_for_new_repositories OrganizationSettings#advanced_security_enabled_for_new_repositories} + +--- + +##### `Blog`Optional + +```csharp +public string Blog { get; set; } +``` + +- *Type:* string + +The blog URL for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#blog OrganizationSettings#blog} + +--- + +##### `Company`Optional + +```csharp +public string Company { get; set; } +``` + +- *Type:* string + +The company name for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#company OrganizationSettings#company} + +--- + +##### `DefaultRepositoryPermission`Optional + +```csharp +public string DefaultRepositoryPermission { get; set; } +``` + +- *Type:* string + +The default permission for organization members to create new repositories. Can be one of 'read', 'write', 'admin' or 'none'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#default_repository_permission OrganizationSettings#default_repository_permission} + +--- + +##### `DependabotAlertsEnabledForNewRepositories`Optional + +```csharp +public bool|IResolvable DependabotAlertsEnabledForNewRepositories { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether or not dependabot alerts are enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#dependabot_alerts_enabled_for_new_repositories OrganizationSettings#dependabot_alerts_enabled_for_new_repositories} + +--- + +##### `DependabotSecurityUpdatesEnabledForNewRepositories`Optional + +```csharp +public bool|IResolvable DependabotSecurityUpdatesEnabledForNewRepositories { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether or not dependabot security updates are enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#dependabot_security_updates_enabled_for_new_repositories OrganizationSettings#dependabot_security_updates_enabled_for_new_repositories} + +--- + +##### `DependencyGraphEnabledForNewRepositories`Optional + +```csharp +public bool|IResolvable DependencyGraphEnabledForNewRepositories { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether or not dependency graph is enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#dependency_graph_enabled_for_new_repositories OrganizationSettings#dependency_graph_enabled_for_new_repositories} + +--- + +##### `Description`Optional + +```csharp +public string Description { get; set; } +``` + +- *Type:* string + +The description for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#description OrganizationSettings#description} + +--- + +##### `Email`Optional + +```csharp +public string Email { get; set; } +``` + +- *Type:* string + +The email address for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#email OrganizationSettings#email} + +--- + +##### `HasOrganizationProjects`Optional + +```csharp +public bool|IResolvable HasOrganizationProjects { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether or not organization projects are enabled for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#has_organization_projects OrganizationSettings#has_organization_projects} + +--- + +##### `HasRepositoryProjects`Optional + +```csharp +public bool|IResolvable HasRepositoryProjects { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether or not repository projects are enabled for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#has_repository_projects OrganizationSettings#has_repository_projects} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#id OrganizationSettings#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. + +--- + +##### `Location`Optional + +```csharp +public string Location { get; set; } +``` + +- *Type:* string + +The location for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#location OrganizationSettings#location} + +--- + +##### `MembersCanCreateInternalRepositories`Optional + +```csharp +public bool|IResolvable MembersCanCreateInternalRepositories { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether or not organization members can create new internal repositories. For Enterprise Organizations only. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_create_internal_repositories OrganizationSettings#members_can_create_internal_repositories} + +--- + +##### `MembersCanCreatePages`Optional + +```csharp +public bool|IResolvable MembersCanCreatePages { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether or not organization members can create new pages. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_create_pages OrganizationSettings#members_can_create_pages} + +--- + +##### `MembersCanCreatePrivatePages`Optional + +```csharp +public bool|IResolvable MembersCanCreatePrivatePages { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether or not organization members can create new private pages. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_create_private_pages OrganizationSettings#members_can_create_private_pages} + +--- + +##### `MembersCanCreatePrivateRepositories`Optional + +```csharp +public bool|IResolvable MembersCanCreatePrivateRepositories { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether or not organization members can create new private repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_create_private_repositories OrganizationSettings#members_can_create_private_repositories} + +--- + +##### `MembersCanCreatePublicPages`Optional + +```csharp +public bool|IResolvable MembersCanCreatePublicPages { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether or not organization members can create new public pages. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_create_public_pages OrganizationSettings#members_can_create_public_pages} + +--- + +##### `MembersCanCreatePublicRepositories`Optional + +```csharp +public bool|IResolvable MembersCanCreatePublicRepositories { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether or not organization members can create new public repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_create_public_repositories OrganizationSettings#members_can_create_public_repositories} + +--- + +##### `MembersCanCreateRepositories`Optional + +```csharp +public bool|IResolvable MembersCanCreateRepositories { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether or not organization members can create new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_create_repositories OrganizationSettings#members_can_create_repositories} + +--- + +##### `MembersCanForkPrivateRepositories`Optional + +```csharp +public bool|IResolvable MembersCanForkPrivateRepositories { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether or not organization members can fork private repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_fork_private_repositories OrganizationSettings#members_can_fork_private_repositories} + +--- + +##### `Name`Optional + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +The name for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#name OrganizationSettings#name} + +--- + +##### `SecretScanningEnabledForNewRepositories`Optional + +```csharp +public bool|IResolvable SecretScanningEnabledForNewRepositories { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether or not secret scanning is enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#secret_scanning_enabled_for_new_repositories OrganizationSettings#secret_scanning_enabled_for_new_repositories} + +--- + +##### `SecretScanningPushProtectionEnabledForNewRepositories`Optional + +```csharp +public bool|IResolvable SecretScanningPushProtectionEnabledForNewRepositories { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether or not secret scanning push protection is enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#secret_scanning_push_protection_enabled_for_new_repositories OrganizationSettings#secret_scanning_push_protection_enabled_for_new_repositories} + +--- + +##### `TwitterUsername`Optional + +```csharp +public string TwitterUsername { get; set; } +``` + +- *Type:* string + +The Twitter username for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#twitter_username OrganizationSettings#twitter_username} + +--- + +##### `WebCommitSignoffRequired`Optional + +```csharp +public bool|IResolvable WebCommitSignoffRequired { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether or not commit signatures are required for commits to the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#web_commit_signoff_required OrganizationSettings#web_commit_signoff_required} + +--- + + + diff --git a/docs/organizationSettings.java.md b/docs/organizationSettings.java.md new file mode 100644 index 000000000..3a517313a --- /dev/null +++ b/docs/organizationSettings.java.md @@ -0,0 +1,2376 @@ +# `organizationSettings` Submodule + +## Constructs + +### OrganizationSettings + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings github_organization_settings}. + +#### Initializers + +```java +import io.cdktn.providers.github.organization_settings.OrganizationSettings; + +OrganizationSettings.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .billingEmail(java.lang.String) +// .advancedSecurityEnabledForNewRepositories(java.lang.Boolean|IResolvable) +// .blog(java.lang.String) +// .company(java.lang.String) +// .defaultRepositoryPermission(java.lang.String) +// .dependabotAlertsEnabledForNewRepositories(java.lang.Boolean|IResolvable) +// .dependabotSecurityUpdatesEnabledForNewRepositories(java.lang.Boolean|IResolvable) +// .dependencyGraphEnabledForNewRepositories(java.lang.Boolean|IResolvable) +// .description(java.lang.String) +// .email(java.lang.String) +// .hasOrganizationProjects(java.lang.Boolean|IResolvable) +// .hasRepositoryProjects(java.lang.Boolean|IResolvable) +// .id(java.lang.String) +// .location(java.lang.String) +// .membersCanCreateInternalRepositories(java.lang.Boolean|IResolvable) +// .membersCanCreatePages(java.lang.Boolean|IResolvable) +// .membersCanCreatePrivatePages(java.lang.Boolean|IResolvable) +// .membersCanCreatePrivateRepositories(java.lang.Boolean|IResolvable) +// .membersCanCreatePublicPages(java.lang.Boolean|IResolvable) +// .membersCanCreatePublicRepositories(java.lang.Boolean|IResolvable) +// .membersCanCreateRepositories(java.lang.Boolean|IResolvable) +// .membersCanForkPrivateRepositories(java.lang.Boolean|IResolvable) +// .name(java.lang.String) +// .secretScanningEnabledForNewRepositories(java.lang.Boolean|IResolvable) +// .secretScanningPushProtectionEnabledForNewRepositories(java.lang.Boolean|IResolvable) +// .twitterUsername(java.lang.String) +// .webCommitSignoffRequired(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 | *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 | *No description.* | +| billingEmail | java.lang.String | The billing email address for the organization. | +| advancedSecurityEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not advanced security is enabled for new repositories. | +| blog | java.lang.String | The blog URL for the organization. | +| company | java.lang.String | The company name for the organization. | +| defaultRepositoryPermission | java.lang.String | The default permission for organization members to create new repositories. Can be one of 'read', 'write', 'admin' or 'none'. | +| dependabotAlertsEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not dependabot alerts are enabled for new repositories. | +| dependabotSecurityUpdatesEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not dependabot security updates are enabled for new repositories. | +| dependencyGraphEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not dependency graph is enabled for new repositories. | +| description | java.lang.String | The description for the organization. | +| email | java.lang.String | The email address for the organization. | +| hasOrganizationProjects | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not organization projects are enabled for the organization. | +| hasRepositoryProjects | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not repository projects are enabled for the organization. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#id OrganizationSettings#id}. | +| location | java.lang.String | The location for the organization. | +| membersCanCreateInternalRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not organization members can create new internal repositories. For Enterprise Organizations only. | +| membersCanCreatePages | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not organization members can create new pages. | +| membersCanCreatePrivatePages | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not organization members can create new private pages. | +| membersCanCreatePrivateRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not organization members can create new private repositories. | +| membersCanCreatePublicPages | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not organization members can create new public pages. | +| membersCanCreatePublicRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not organization members can create new public repositories. | +| membersCanCreateRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not organization members can create new repositories. | +| membersCanForkPrivateRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not organization members can fork private repositories. | +| name | java.lang.String | The name for the organization. | +| secretScanningEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not secret scanning is enabled for new repositories. | +| secretScanningPushProtectionEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not secret scanning push protection is enabled for new repositories. | +| twitterUsername | java.lang.String | The Twitter username for the organization. | +| webCommitSignoffRequired | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not commit signatures are required for commits to the organization. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `billingEmail`Required + +- *Type:* java.lang.String + +The billing email address for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#billing_email OrganizationSettings#billing_email} + +--- + +##### `advancedSecurityEnabledForNewRepositories`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not advanced security is enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#advanced_security_enabled_for_new_repositories OrganizationSettings#advanced_security_enabled_for_new_repositories} + +--- + +##### `blog`Optional + +- *Type:* java.lang.String + +The blog URL for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#blog OrganizationSettings#blog} + +--- + +##### `company`Optional + +- *Type:* java.lang.String + +The company name for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#company OrganizationSettings#company} + +--- + +##### `defaultRepositoryPermission`Optional + +- *Type:* java.lang.String + +The default permission for organization members to create new repositories. Can be one of 'read', 'write', 'admin' or 'none'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#default_repository_permission OrganizationSettings#default_repository_permission} + +--- + +##### `dependabotAlertsEnabledForNewRepositories`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not dependabot alerts are enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#dependabot_alerts_enabled_for_new_repositories OrganizationSettings#dependabot_alerts_enabled_for_new_repositories} + +--- + +##### `dependabotSecurityUpdatesEnabledForNewRepositories`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not dependabot security updates are enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#dependabot_security_updates_enabled_for_new_repositories OrganizationSettings#dependabot_security_updates_enabled_for_new_repositories} + +--- + +##### `dependencyGraphEnabledForNewRepositories`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not dependency graph is enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#dependency_graph_enabled_for_new_repositories OrganizationSettings#dependency_graph_enabled_for_new_repositories} + +--- + +##### `description`Optional + +- *Type:* java.lang.String + +The description for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#description OrganizationSettings#description} + +--- + +##### `email`Optional + +- *Type:* java.lang.String + +The email address for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#email OrganizationSettings#email} + +--- + +##### `hasOrganizationProjects`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not organization projects are enabled for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#has_organization_projects OrganizationSettings#has_organization_projects} + +--- + +##### `hasRepositoryProjects`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not repository projects are enabled for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#has_repository_projects OrganizationSettings#has_repository_projects} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#id OrganizationSettings#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. + +--- + +##### `location`Optional + +- *Type:* java.lang.String + +The location for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#location OrganizationSettings#location} + +--- + +##### `membersCanCreateInternalRepositories`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not organization members can create new internal repositories. For Enterprise Organizations only. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_create_internal_repositories OrganizationSettings#members_can_create_internal_repositories} + +--- + +##### `membersCanCreatePages`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not organization members can create new pages. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_create_pages OrganizationSettings#members_can_create_pages} + +--- + +##### `membersCanCreatePrivatePages`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not organization members can create new private pages. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_create_private_pages OrganizationSettings#members_can_create_private_pages} + +--- + +##### `membersCanCreatePrivateRepositories`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not organization members can create new private repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_create_private_repositories OrganizationSettings#members_can_create_private_repositories} + +--- + +##### `membersCanCreatePublicPages`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not organization members can create new public pages. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_create_public_pages OrganizationSettings#members_can_create_public_pages} + +--- + +##### `membersCanCreatePublicRepositories`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not organization members can create new public repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_create_public_repositories OrganizationSettings#members_can_create_public_repositories} + +--- + +##### `membersCanCreateRepositories`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not organization members can create new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_create_repositories OrganizationSettings#members_can_create_repositories} + +--- + +##### `membersCanForkPrivateRepositories`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not organization members can fork private repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_fork_private_repositories OrganizationSettings#members_can_fork_private_repositories} + +--- + +##### `name`Optional + +- *Type:* java.lang.String + +The name for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#name OrganizationSettings#name} + +--- + +##### `secretScanningEnabledForNewRepositories`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not secret scanning is enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#secret_scanning_enabled_for_new_repositories OrganizationSettings#secret_scanning_enabled_for_new_repositories} + +--- + +##### `secretScanningPushProtectionEnabledForNewRepositories`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not secret scanning push protection is enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#secret_scanning_push_protection_enabled_for_new_repositories OrganizationSettings#secret_scanning_push_protection_enabled_for_new_repositories} + +--- + +##### `twitterUsername`Optional + +- *Type:* java.lang.String + +The Twitter username for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#twitter_username OrganizationSettings#twitter_username} + +--- + +##### `webCommitSignoffRequired`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not commit signatures are required for commits to the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#web_commit_signoff_required OrganizationSettings#web_commit_signoff_required} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetAdvancedSecurityEnabledForNewRepositories | *No description.* | +| resetBlog | *No description.* | +| resetCompany | *No description.* | +| resetDefaultRepositoryPermission | *No description.* | +| resetDependabotAlertsEnabledForNewRepositories | *No description.* | +| resetDependabotSecurityUpdatesEnabledForNewRepositories | *No description.* | +| resetDependencyGraphEnabledForNewRepositories | *No description.* | +| resetDescription | *No description.* | +| resetEmail | *No description.* | +| resetHasOrganizationProjects | *No description.* | +| resetHasRepositoryProjects | *No description.* | +| resetId | *No description.* | +| resetLocation | *No description.* | +| resetMembersCanCreateInternalRepositories | *No description.* | +| resetMembersCanCreatePages | *No description.* | +| resetMembersCanCreatePrivatePages | *No description.* | +| resetMembersCanCreatePrivateRepositories | *No description.* | +| resetMembersCanCreatePublicPages | *No description.* | +| resetMembersCanCreatePublicRepositories | *No description.* | +| resetMembersCanCreateRepositories | *No description.* | +| resetMembersCanForkPrivateRepositories | *No description.* | +| resetName | *No description.* | +| resetSecretScanningEnabledForNewRepositories | *No description.* | +| resetSecretScanningPushProtectionEnabledForNewRepositories | *No description.* | +| resetTwitterUsername | *No description.* | +| resetWebCommitSignoffRequired | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetAdvancedSecurityEnabledForNewRepositories` + +```java +public void resetAdvancedSecurityEnabledForNewRepositories() +``` + +##### `resetBlog` + +```java +public void resetBlog() +``` + +##### `resetCompany` + +```java +public void resetCompany() +``` + +##### `resetDefaultRepositoryPermission` + +```java +public void resetDefaultRepositoryPermission() +``` + +##### `resetDependabotAlertsEnabledForNewRepositories` + +```java +public void resetDependabotAlertsEnabledForNewRepositories() +``` + +##### `resetDependabotSecurityUpdatesEnabledForNewRepositories` + +```java +public void resetDependabotSecurityUpdatesEnabledForNewRepositories() +``` + +##### `resetDependencyGraphEnabledForNewRepositories` + +```java +public void resetDependencyGraphEnabledForNewRepositories() +``` + +##### `resetDescription` + +```java +public void resetDescription() +``` + +##### `resetEmail` + +```java +public void resetEmail() +``` + +##### `resetHasOrganizationProjects` + +```java +public void resetHasOrganizationProjects() +``` + +##### `resetHasRepositoryProjects` + +```java +public void resetHasRepositoryProjects() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetLocation` + +```java +public void resetLocation() +``` + +##### `resetMembersCanCreateInternalRepositories` + +```java +public void resetMembersCanCreateInternalRepositories() +``` + +##### `resetMembersCanCreatePages` + +```java +public void resetMembersCanCreatePages() +``` + +##### `resetMembersCanCreatePrivatePages` + +```java +public void resetMembersCanCreatePrivatePages() +``` + +##### `resetMembersCanCreatePrivateRepositories` + +```java +public void resetMembersCanCreatePrivateRepositories() +``` + +##### `resetMembersCanCreatePublicPages` + +```java +public void resetMembersCanCreatePublicPages() +``` + +##### `resetMembersCanCreatePublicRepositories` + +```java +public void resetMembersCanCreatePublicRepositories() +``` + +##### `resetMembersCanCreateRepositories` + +```java +public void resetMembersCanCreateRepositories() +``` + +##### `resetMembersCanForkPrivateRepositories` + +```java +public void resetMembersCanForkPrivateRepositories() +``` + +##### `resetName` + +```java +public void resetName() +``` + +##### `resetSecretScanningEnabledForNewRepositories` + +```java +public void resetSecretScanningEnabledForNewRepositories() +``` + +##### `resetSecretScanningPushProtectionEnabledForNewRepositories` + +```java +public void resetSecretScanningPushProtectionEnabledForNewRepositories() +``` + +##### `resetTwitterUsername` + +```java +public void resetTwitterUsername() +``` + +##### `resetWebCommitSignoffRequired` + +```java +public void resetWebCommitSignoffRequired() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a OrganizationSettings resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.organization_settings.OrganizationSettings; + +OrganizationSettings.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` + +```java +import io.cdktn.providers.github.organization_settings.OrganizationSettings; + +OrganizationSettings.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.organization_settings.OrganizationSettings; + +OrganizationSettings.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.organization_settings.OrganizationSettings; + +OrganizationSettings.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),OrganizationSettings.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a OrganizationSettings 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 OrganizationSettings to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing OrganizationSettings that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#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 OrganizationSettings 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| advancedSecurityEnabledForNewRepositoriesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| billingEmailInput | java.lang.String | *No description.* | +| blogInput | java.lang.String | *No description.* | +| companyInput | java.lang.String | *No description.* | +| defaultRepositoryPermissionInput | java.lang.String | *No description.* | +| dependabotAlertsEnabledForNewRepositoriesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| dependabotSecurityUpdatesEnabledForNewRepositoriesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| dependencyGraphEnabledForNewRepositoriesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| descriptionInput | java.lang.String | *No description.* | +| emailInput | java.lang.String | *No description.* | +| hasOrganizationProjectsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| hasRepositoryProjectsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| idInput | java.lang.String | *No description.* | +| locationInput | java.lang.String | *No description.* | +| membersCanCreateInternalRepositoriesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| membersCanCreatePagesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| membersCanCreatePrivatePagesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| membersCanCreatePrivateRepositoriesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| membersCanCreatePublicPagesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| membersCanCreatePublicRepositoriesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| membersCanCreateRepositoriesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| membersCanForkPrivateRepositoriesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| nameInput | java.lang.String | *No description.* | +| secretScanningEnabledForNewRepositoriesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| secretScanningPushProtectionEnabledForNewRepositoriesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| twitterUsernameInput | java.lang.String | *No description.* | +| webCommitSignoffRequiredInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| advancedSecurityEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| billingEmail | java.lang.String | *No description.* | +| blog | java.lang.String | *No description.* | +| company | java.lang.String | *No description.* | +| defaultRepositoryPermission | java.lang.String | *No description.* | +| dependabotAlertsEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| dependabotSecurityUpdatesEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| dependencyGraphEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| description | java.lang.String | *No description.* | +| email | java.lang.String | *No description.* | +| hasOrganizationProjects | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| hasRepositoryProjects | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| id | java.lang.String | *No description.* | +| location | java.lang.String | *No description.* | +| membersCanCreateInternalRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| membersCanCreatePages | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| membersCanCreatePrivatePages | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| membersCanCreatePrivateRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| membersCanCreatePublicPages | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| membersCanCreatePublicRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| membersCanCreateRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| membersCanForkPrivateRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| name | java.lang.String | *No description.* | +| secretScanningEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| secretScanningPushProtectionEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| twitterUsername | java.lang.String | *No description.* | +| webCommitSignoffRequired | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `advancedSecurityEnabledForNewRepositoriesInput`Optional + +```java +public java.lang.Boolean|IResolvable getAdvancedSecurityEnabledForNewRepositoriesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `billingEmailInput`Optional + +```java +public java.lang.String getBillingEmailInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `blogInput`Optional + +```java +public java.lang.String getBlogInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `companyInput`Optional + +```java +public java.lang.String getCompanyInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `defaultRepositoryPermissionInput`Optional + +```java +public java.lang.String getDefaultRepositoryPermissionInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `dependabotAlertsEnabledForNewRepositoriesInput`Optional + +```java +public java.lang.Boolean|IResolvable getDependabotAlertsEnabledForNewRepositoriesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `dependabotSecurityUpdatesEnabledForNewRepositoriesInput`Optional + +```java +public java.lang.Boolean|IResolvable getDependabotSecurityUpdatesEnabledForNewRepositoriesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `dependencyGraphEnabledForNewRepositoriesInput`Optional + +```java +public java.lang.Boolean|IResolvable getDependencyGraphEnabledForNewRepositoriesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `descriptionInput`Optional + +```java +public java.lang.String getDescriptionInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `emailInput`Optional + +```java +public java.lang.String getEmailInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `hasOrganizationProjectsInput`Optional + +```java +public java.lang.Boolean|IResolvable getHasOrganizationProjectsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `hasRepositoryProjectsInput`Optional + +```java +public java.lang.Boolean|IResolvable getHasRepositoryProjectsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `locationInput`Optional + +```java +public java.lang.String getLocationInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `membersCanCreateInternalRepositoriesInput`Optional + +```java +public java.lang.Boolean|IResolvable getMembersCanCreateInternalRepositoriesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `membersCanCreatePagesInput`Optional + +```java +public java.lang.Boolean|IResolvable getMembersCanCreatePagesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `membersCanCreatePrivatePagesInput`Optional + +```java +public java.lang.Boolean|IResolvable getMembersCanCreatePrivatePagesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `membersCanCreatePrivateRepositoriesInput`Optional + +```java +public java.lang.Boolean|IResolvable getMembersCanCreatePrivateRepositoriesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `membersCanCreatePublicPagesInput`Optional + +```java +public java.lang.Boolean|IResolvable getMembersCanCreatePublicPagesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `membersCanCreatePublicRepositoriesInput`Optional + +```java +public java.lang.Boolean|IResolvable getMembersCanCreatePublicRepositoriesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `membersCanCreateRepositoriesInput`Optional + +```java +public java.lang.Boolean|IResolvable getMembersCanCreateRepositoriesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `membersCanForkPrivateRepositoriesInput`Optional + +```java +public java.lang.Boolean|IResolvable getMembersCanForkPrivateRepositoriesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretScanningEnabledForNewRepositoriesInput`Optional + +```java +public java.lang.Boolean|IResolvable getSecretScanningEnabledForNewRepositoriesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `secretScanningPushProtectionEnabledForNewRepositoriesInput`Optional + +```java +public java.lang.Boolean|IResolvable getSecretScanningPushProtectionEnabledForNewRepositoriesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `twitterUsernameInput`Optional + +```java +public java.lang.String getTwitterUsernameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `webCommitSignoffRequiredInput`Optional + +```java +public java.lang.Boolean|IResolvable getWebCommitSignoffRequiredInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `advancedSecurityEnabledForNewRepositories`Required + +```java +public java.lang.Boolean|IResolvable getAdvancedSecurityEnabledForNewRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `billingEmail`Required + +```java +public java.lang.String getBillingEmail(); +``` + +- *Type:* java.lang.String + +--- + +##### `blog`Required + +```java +public java.lang.String getBlog(); +``` + +- *Type:* java.lang.String + +--- + +##### `company`Required + +```java +public java.lang.String getCompany(); +``` + +- *Type:* java.lang.String + +--- + +##### `defaultRepositoryPermission`Required + +```java +public java.lang.String getDefaultRepositoryPermission(); +``` + +- *Type:* java.lang.String + +--- + +##### `dependabotAlertsEnabledForNewRepositories`Required + +```java +public java.lang.Boolean|IResolvable getDependabotAlertsEnabledForNewRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `dependabotSecurityUpdatesEnabledForNewRepositories`Required + +```java +public java.lang.Boolean|IResolvable getDependabotSecurityUpdatesEnabledForNewRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `dependencyGraphEnabledForNewRepositories`Required + +```java +public java.lang.Boolean|IResolvable getDependencyGraphEnabledForNewRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `email`Required + +```java +public java.lang.String getEmail(); +``` + +- *Type:* java.lang.String + +--- + +##### `hasOrganizationProjects`Required + +```java +public java.lang.Boolean|IResolvable getHasOrganizationProjects(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `hasRepositoryProjects`Required + +```java +public java.lang.Boolean|IResolvable getHasRepositoryProjects(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `location`Required + +```java +public java.lang.String getLocation(); +``` + +- *Type:* java.lang.String + +--- + +##### `membersCanCreateInternalRepositories`Required + +```java +public java.lang.Boolean|IResolvable getMembersCanCreateInternalRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `membersCanCreatePages`Required + +```java +public java.lang.Boolean|IResolvable getMembersCanCreatePages(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `membersCanCreatePrivatePages`Required + +```java +public java.lang.Boolean|IResolvable getMembersCanCreatePrivatePages(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `membersCanCreatePrivateRepositories`Required + +```java +public java.lang.Boolean|IResolvable getMembersCanCreatePrivateRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `membersCanCreatePublicPages`Required + +```java +public java.lang.Boolean|IResolvable getMembersCanCreatePublicPages(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `membersCanCreatePublicRepositories`Required + +```java +public java.lang.Boolean|IResolvable getMembersCanCreatePublicRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `membersCanCreateRepositories`Required + +```java +public java.lang.Boolean|IResolvable getMembersCanCreateRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `membersCanForkPrivateRepositories`Required + +```java +public java.lang.Boolean|IResolvable getMembersCanForkPrivateRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `secretScanningEnabledForNewRepositories`Required + +```java +public java.lang.Boolean|IResolvable getSecretScanningEnabledForNewRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `secretScanningPushProtectionEnabledForNewRepositories`Required + +```java +public java.lang.Boolean|IResolvable getSecretScanningPushProtectionEnabledForNewRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `twitterUsername`Required + +```java +public java.lang.String getTwitterUsername(); +``` + +- *Type:* java.lang.String + +--- + +##### `webCommitSignoffRequired`Required + +```java +public java.lang.Boolean|IResolvable getWebCommitSignoffRequired(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### OrganizationSettingsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.organization_settings.OrganizationSettingsConfig; + +OrganizationSettingsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .billingEmail(java.lang.String) +// .advancedSecurityEnabledForNewRepositories(java.lang.Boolean|IResolvable) +// .blog(java.lang.String) +// .company(java.lang.String) +// .defaultRepositoryPermission(java.lang.String) +// .dependabotAlertsEnabledForNewRepositories(java.lang.Boolean|IResolvable) +// .dependabotSecurityUpdatesEnabledForNewRepositories(java.lang.Boolean|IResolvable) +// .dependencyGraphEnabledForNewRepositories(java.lang.Boolean|IResolvable) +// .description(java.lang.String) +// .email(java.lang.String) +// .hasOrganizationProjects(java.lang.Boolean|IResolvable) +// .hasRepositoryProjects(java.lang.Boolean|IResolvable) +// .id(java.lang.String) +// .location(java.lang.String) +// .membersCanCreateInternalRepositories(java.lang.Boolean|IResolvable) +// .membersCanCreatePages(java.lang.Boolean|IResolvable) +// .membersCanCreatePrivatePages(java.lang.Boolean|IResolvable) +// .membersCanCreatePrivateRepositories(java.lang.Boolean|IResolvable) +// .membersCanCreatePublicPages(java.lang.Boolean|IResolvable) +// .membersCanCreatePublicRepositories(java.lang.Boolean|IResolvable) +// .membersCanCreateRepositories(java.lang.Boolean|IResolvable) +// .membersCanForkPrivateRepositories(java.lang.Boolean|IResolvable) +// .name(java.lang.String) +// .secretScanningEnabledForNewRepositories(java.lang.Boolean|IResolvable) +// .secretScanningPushProtectionEnabledForNewRepositories(java.lang.Boolean|IResolvable) +// .twitterUsername(java.lang.String) +// .webCommitSignoffRequired(java.lang.Boolean|IResolvable) + .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 | *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 | *No description.* | +| billingEmail | java.lang.String | The billing email address for the organization. | +| advancedSecurityEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not advanced security is enabled for new repositories. | +| blog | java.lang.String | The blog URL for the organization. | +| company | java.lang.String | The company name for the organization. | +| defaultRepositoryPermission | java.lang.String | The default permission for organization members to create new repositories. Can be one of 'read', 'write', 'admin' or 'none'. | +| dependabotAlertsEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not dependabot alerts are enabled for new repositories. | +| dependabotSecurityUpdatesEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not dependabot security updates are enabled for new repositories. | +| dependencyGraphEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not dependency graph is enabled for new repositories. | +| description | java.lang.String | The description for the organization. | +| email | java.lang.String | The email address for the organization. | +| hasOrganizationProjects | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not organization projects are enabled for the organization. | +| hasRepositoryProjects | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not repository projects are enabled for the organization. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#id OrganizationSettings#id}. | +| location | java.lang.String | The location for the organization. | +| membersCanCreateInternalRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not organization members can create new internal repositories. For Enterprise Organizations only. | +| membersCanCreatePages | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not organization members can create new pages. | +| membersCanCreatePrivatePages | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not organization members can create new private pages. | +| membersCanCreatePrivateRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not organization members can create new private repositories. | +| membersCanCreatePublicPages | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not organization members can create new public pages. | +| membersCanCreatePublicRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not organization members can create new public repositories. | +| membersCanCreateRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not organization members can create new repositories. | +| membersCanForkPrivateRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not organization members can fork private repositories. | +| name | java.lang.String | The name for the organization. | +| secretScanningEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not secret scanning is enabled for new repositories. | +| secretScanningPushProtectionEnabledForNewRepositories | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not secret scanning push protection is enabled for new repositories. | +| twitterUsername | java.lang.String | The Twitter username for the organization. | +| webCommitSignoffRequired | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether or not commit signatures are required for commits to the organization. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `billingEmail`Required + +```java +public java.lang.String getBillingEmail(); +``` + +- *Type:* java.lang.String + +The billing email address for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#billing_email OrganizationSettings#billing_email} + +--- + +##### `advancedSecurityEnabledForNewRepositories`Optional + +```java +public java.lang.Boolean|IResolvable getAdvancedSecurityEnabledForNewRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not advanced security is enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#advanced_security_enabled_for_new_repositories OrganizationSettings#advanced_security_enabled_for_new_repositories} + +--- + +##### `blog`Optional + +```java +public java.lang.String getBlog(); +``` + +- *Type:* java.lang.String + +The blog URL for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#blog OrganizationSettings#blog} + +--- + +##### `company`Optional + +```java +public java.lang.String getCompany(); +``` + +- *Type:* java.lang.String + +The company name for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#company OrganizationSettings#company} + +--- + +##### `defaultRepositoryPermission`Optional + +```java +public java.lang.String getDefaultRepositoryPermission(); +``` + +- *Type:* java.lang.String + +The default permission for organization members to create new repositories. Can be one of 'read', 'write', 'admin' or 'none'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#default_repository_permission OrganizationSettings#default_repository_permission} + +--- + +##### `dependabotAlertsEnabledForNewRepositories`Optional + +```java +public java.lang.Boolean|IResolvable getDependabotAlertsEnabledForNewRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not dependabot alerts are enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#dependabot_alerts_enabled_for_new_repositories OrganizationSettings#dependabot_alerts_enabled_for_new_repositories} + +--- + +##### `dependabotSecurityUpdatesEnabledForNewRepositories`Optional + +```java +public java.lang.Boolean|IResolvable getDependabotSecurityUpdatesEnabledForNewRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not dependabot security updates are enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#dependabot_security_updates_enabled_for_new_repositories OrganizationSettings#dependabot_security_updates_enabled_for_new_repositories} + +--- + +##### `dependencyGraphEnabledForNewRepositories`Optional + +```java +public java.lang.Boolean|IResolvable getDependencyGraphEnabledForNewRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not dependency graph is enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#dependency_graph_enabled_for_new_repositories OrganizationSettings#dependency_graph_enabled_for_new_repositories} + +--- + +##### `description`Optional + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +The description for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#description OrganizationSettings#description} + +--- + +##### `email`Optional + +```java +public java.lang.String getEmail(); +``` + +- *Type:* java.lang.String + +The email address for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#email OrganizationSettings#email} + +--- + +##### `hasOrganizationProjects`Optional + +```java +public java.lang.Boolean|IResolvable getHasOrganizationProjects(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not organization projects are enabled for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#has_organization_projects OrganizationSettings#has_organization_projects} + +--- + +##### `hasRepositoryProjects`Optional + +```java +public java.lang.Boolean|IResolvable getHasRepositoryProjects(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not repository projects are enabled for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#has_repository_projects OrganizationSettings#has_repository_projects} + +--- + +##### `id`Optional + +```java +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/resources/organization_settings#id OrganizationSettings#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. + +--- + +##### `location`Optional + +```java +public java.lang.String getLocation(); +``` + +- *Type:* java.lang.String + +The location for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#location OrganizationSettings#location} + +--- + +##### `membersCanCreateInternalRepositories`Optional + +```java +public java.lang.Boolean|IResolvable getMembersCanCreateInternalRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not organization members can create new internal repositories. For Enterprise Organizations only. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_create_internal_repositories OrganizationSettings#members_can_create_internal_repositories} + +--- + +##### `membersCanCreatePages`Optional + +```java +public java.lang.Boolean|IResolvable getMembersCanCreatePages(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not organization members can create new pages. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_create_pages OrganizationSettings#members_can_create_pages} + +--- + +##### `membersCanCreatePrivatePages`Optional + +```java +public java.lang.Boolean|IResolvable getMembersCanCreatePrivatePages(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not organization members can create new private pages. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_create_private_pages OrganizationSettings#members_can_create_private_pages} + +--- + +##### `membersCanCreatePrivateRepositories`Optional + +```java +public java.lang.Boolean|IResolvable getMembersCanCreatePrivateRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not organization members can create new private repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_create_private_repositories OrganizationSettings#members_can_create_private_repositories} + +--- + +##### `membersCanCreatePublicPages`Optional + +```java +public java.lang.Boolean|IResolvable getMembersCanCreatePublicPages(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not organization members can create new public pages. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_create_public_pages OrganizationSettings#members_can_create_public_pages} + +--- + +##### `membersCanCreatePublicRepositories`Optional + +```java +public java.lang.Boolean|IResolvable getMembersCanCreatePublicRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not organization members can create new public repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_create_public_repositories OrganizationSettings#members_can_create_public_repositories} + +--- + +##### `membersCanCreateRepositories`Optional + +```java +public java.lang.Boolean|IResolvable getMembersCanCreateRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not organization members can create new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_create_repositories OrganizationSettings#members_can_create_repositories} + +--- + +##### `membersCanForkPrivateRepositories`Optional + +```java +public java.lang.Boolean|IResolvable getMembersCanForkPrivateRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not organization members can fork private repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#members_can_fork_private_repositories OrganizationSettings#members_can_fork_private_repositories} + +--- + +##### `name`Optional + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +The name for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#name OrganizationSettings#name} + +--- + +##### `secretScanningEnabledForNewRepositories`Optional + +```java +public java.lang.Boolean|IResolvable getSecretScanningEnabledForNewRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not secret scanning is enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#secret_scanning_enabled_for_new_repositories OrganizationSettings#secret_scanning_enabled_for_new_repositories} + +--- + +##### `secretScanningPushProtectionEnabledForNewRepositories`Optional + +```java +public java.lang.Boolean|IResolvable getSecretScanningPushProtectionEnabledForNewRepositories(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not secret scanning push protection is enabled for new repositories. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#secret_scanning_push_protection_enabled_for_new_repositories OrganizationSettings#secret_scanning_push_protection_enabled_for_new_repositories} + +--- + +##### `twitterUsername`Optional + +```java +public java.lang.String getTwitterUsername(); +``` + +- *Type:* java.lang.String + +The Twitter username for the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#twitter_username OrganizationSettings#twitter_username} + +--- + +##### `webCommitSignoffRequired`Optional + +```java +public java.lang.Boolean|IResolvable getWebCommitSignoffRequired(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether or not commit signatures are required for commits to the organization. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_settings#web_commit_signoff_required OrganizationSettings#web_commit_signoff_required} + +--- + + + diff --git a/docs/organizationWebhook.csharp.md b/docs/organizationWebhook.csharp.md new file mode 100644 index 000000000..6792f80b2 --- /dev/null +++ b/docs/organizationWebhook.csharp.md @@ -0,0 +1,1440 @@ +# `organizationWebhook` Submodule + +## Constructs + +### OrganizationWebhook + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook github_organization_webhook}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationWebhook(Construct Scope, string Id, OrganizationWebhookConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | OrganizationWebhookConfig | *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:* OrganizationWebhookConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| PutConfiguration | *No description.* | +| ResetActive | *No description.* | +| ResetConfiguration | *No description.* | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `PutConfiguration` + +```csharp +private void PutConfiguration(OrganizationWebhookConfiguration Value) +``` + +###### `Value`Required + +- *Type:* OrganizationWebhookConfiguration + +--- + +##### `ResetActive` + +```csharp +private void ResetActive() +``` + +##### `ResetConfiguration` + +```csharp +private void ResetConfiguration() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a OrganizationWebhook resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationWebhook.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` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationWebhook.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationWebhook.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +OrganizationWebhook.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a OrganizationWebhook resource upon running "cdktn 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 OrganizationWebhook to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing OrganizationWebhook that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the OrganizationWebhook to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Configuration | OrganizationWebhookConfigurationOutputReference | *No description.* | +| Etag | string | *No description.* | +| Url | string | *No description.* | +| ActiveInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| ConfigurationInput | OrganizationWebhookConfiguration | *No description.* | +| EventsInput | string[] | *No description.* | +| IdInput | string | *No description.* | +| Active | bool\|Io.Cdktn.IResolvable | *No description.* | +| Events | string[] | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Configuration`Required + +```csharp +public OrganizationWebhookConfigurationOutputReference Configuration { get; } +``` + +- *Type:* OrganizationWebhookConfigurationOutputReference + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `Url`Required + +```csharp +public string Url { get; } +``` + +- *Type:* string + +--- + +##### `ActiveInput`Optional + +```csharp +public bool|IResolvable ActiveInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ConfigurationInput`Optional + +```csharp +public OrganizationWebhookConfiguration ConfigurationInput { get; } +``` + +- *Type:* OrganizationWebhookConfiguration + +--- + +##### `EventsInput`Optional + +```csharp +public string[] EventsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `Active`Required + +```csharp +public bool|IResolvable Active { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Events`Required + +```csharp +public string[] Events { get; } +``` + +- *Type:* string[] + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### OrganizationWebhookConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationWebhookConfig { + 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[] Events, + bool|IResolvable Active = null, + OrganizationWebhookConfiguration Configuration = null, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Events | string[] | A list of events which should trigger the webhook. | +| Active | bool\|Io.Cdktn.IResolvable | Indicate if the webhook should receive events. | +| Configuration | OrganizationWebhookConfiguration | configuration block. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#id OrganizationWebhook#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Events`Required + +```csharp +public string[] Events { get; set; } +``` + +- *Type:* string[] + +A list of events which should trigger the webhook. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#events OrganizationWebhook#events} + +--- + +##### `Active`Optional + +```csharp +public bool|IResolvable Active { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Indicate if the webhook should receive events. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#active OrganizationWebhook#active} + +--- + +##### `Configuration`Optional + +```csharp +public OrganizationWebhookConfiguration Configuration { get; set; } +``` + +- *Type:* OrganizationWebhookConfiguration + +configuration block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#configuration OrganizationWebhook#configuration} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#id OrganizationWebhook#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. + +--- + +### OrganizationWebhookConfiguration + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationWebhookConfiguration { + string Url, + string ContentType = null, + bool|IResolvable InsecureSsl = null, + string Secret = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Url | string | The URL of the webhook. | +| ContentType | string | The content type for the payload. Valid values are either 'form' or 'json'. | +| InsecureSsl | bool\|Io.Cdktn.IResolvable | Insecure SSL boolean toggle. Defaults to 'false'. | +| Secret | string | The shared secret for the webhook. | + +--- + +##### `Url`Required + +```csharp +public string Url { get; set; } +``` + +- *Type:* string + +The URL of the webhook. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#url OrganizationWebhook#url} + +--- + +##### `ContentType`Optional + +```csharp +public string ContentType { get; set; } +``` + +- *Type:* string + +The content type for the payload. Valid values are either 'form' or 'json'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#content_type OrganizationWebhook#content_type} + +--- + +##### `InsecureSsl`Optional + +```csharp +public bool|IResolvable InsecureSsl { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Insecure SSL boolean toggle. Defaults to 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#insecure_ssl OrganizationWebhook#insecure_ssl} + +--- + +##### `Secret`Optional + +```csharp +public string Secret { get; set; } +``` + +- *Type:* string + +The shared secret for the webhook. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#secret OrganizationWebhook#secret} + +--- + +## Classes + +### OrganizationWebhookConfigurationOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new OrganizationWebhookConfigurationOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetContentType | *No description.* | +| ResetInsecureSsl | *No description.* | +| ResetSecret | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetContentType` + +```csharp +private void ResetContentType() +``` + +##### `ResetInsecureSsl` + +```csharp +private void ResetInsecureSsl() +``` + +##### `ResetSecret` + +```csharp +private void ResetSecret() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| ContentTypeInput | string | *No description.* | +| InsecureSslInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| SecretInput | string | *No description.* | +| UrlInput | string | *No description.* | +| ContentType | string | *No description.* | +| InsecureSsl | bool\|Io.Cdktn.IResolvable | *No description.* | +| Secret | string | *No description.* | +| Url | string | *No description.* | +| InternalValue | OrganizationWebhookConfiguration | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `ContentTypeInput`Optional + +```csharp +public string ContentTypeInput { get; } +``` + +- *Type:* string + +--- + +##### `InsecureSslInput`Optional + +```csharp +public bool|IResolvable InsecureSslInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `SecretInput`Optional + +```csharp +public string SecretInput { get; } +``` + +- *Type:* string + +--- + +##### `UrlInput`Optional + +```csharp +public string UrlInput { get; } +``` + +- *Type:* string + +--- + +##### `ContentType`Required + +```csharp +public string ContentType { get; } +``` + +- *Type:* string + +--- + +##### `InsecureSsl`Required + +```csharp +public bool|IResolvable InsecureSsl { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Secret`Required + +```csharp +public string Secret { get; } +``` + +- *Type:* string + +--- + +##### `Url`Required + +```csharp +public string Url { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public OrganizationWebhookConfiguration InternalValue { get; } +``` + +- *Type:* OrganizationWebhookConfiguration + +--- + + + diff --git a/docs/organizationWebhook.java.md b/docs/organizationWebhook.java.md new file mode 100644 index 000000000..c2a4cb0d2 --- /dev/null +++ b/docs/organizationWebhook.java.md @@ -0,0 +1,1541 @@ +# `organizationWebhook` Submodule + +## Constructs + +### OrganizationWebhook + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook github_organization_webhook}. + +#### Initializers + +```java +import io.cdktn.providers.github.organization_webhook.OrganizationWebhook; + +OrganizationWebhook.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .events(java.util.List) +// .active(java.lang.Boolean|IResolvable) +// .configuration(OrganizationWebhookConfiguration) +// .id(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 | *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 | *No description.* | +| events | java.util.List | A list of events which should trigger the webhook. | +| active | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Indicate if the webhook should receive events. | +| configuration | OrganizationWebhookConfiguration | configuration block. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#id OrganizationWebhook#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `events`Required + +- *Type:* java.util.List + +A list of events which should trigger the webhook. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#events OrganizationWebhook#events} + +--- + +##### `active`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Indicate if the webhook should receive events. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#active OrganizationWebhook#active} + +--- + +##### `configuration`Optional + +- *Type:* OrganizationWebhookConfiguration + +configuration block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#configuration OrganizationWebhook#configuration} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#id OrganizationWebhook#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| putConfiguration | *No description.* | +| resetActive | *No description.* | +| resetConfiguration | *No description.* | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `putConfiguration` + +```java +public void putConfiguration(OrganizationWebhookConfiguration value) +``` + +###### `value`Required + +- *Type:* OrganizationWebhookConfiguration + +--- + +##### `resetActive` + +```java +public void resetActive() +``` + +##### `resetConfiguration` + +```java +public void resetConfiguration() +``` + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a OrganizationWebhook resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.organization_webhook.OrganizationWebhook; + +OrganizationWebhook.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` + +```java +import io.cdktn.providers.github.organization_webhook.OrganizationWebhook; + +OrganizationWebhook.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.organization_webhook.OrganizationWebhook; + +OrganizationWebhook.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.organization_webhook.OrganizationWebhook; + +OrganizationWebhook.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),OrganizationWebhook.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a OrganizationWebhook 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 OrganizationWebhook to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing OrganizationWebhook that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#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 OrganizationWebhook 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| configuration | OrganizationWebhookConfigurationOutputReference | *No description.* | +| etag | java.lang.String | *No description.* | +| url | java.lang.String | *No description.* | +| activeInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| configurationInput | OrganizationWebhookConfiguration | *No description.* | +| eventsInput | java.util.List | *No description.* | +| idInput | java.lang.String | *No description.* | +| active | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| events | java.util.List | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `configuration`Required + +```java +public OrganizationWebhookConfigurationOutputReference getConfiguration(); +``` + +- *Type:* OrganizationWebhookConfigurationOutputReference + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `activeInput`Optional + +```java +public java.lang.Boolean|IResolvable getActiveInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `configurationInput`Optional + +```java +public OrganizationWebhookConfiguration getConfigurationInput(); +``` + +- *Type:* OrganizationWebhookConfiguration + +--- + +##### `eventsInput`Optional + +```java +public java.util.List getEventsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `active`Required + +```java +public java.lang.Boolean|IResolvable getActive(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `events`Required + +```java +public java.util.List getEvents(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### OrganizationWebhookConfig + +#### Initializer + +```java +import io.cdktn.providers.github.organization_webhook.OrganizationWebhookConfig; + +OrganizationWebhookConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .events(java.util.List) +// .active(java.lang.Boolean|IResolvable) +// .configuration(OrganizationWebhookConfiguration) +// .id(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 | *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 | *No description.* | +| events | java.util.List | A list of events which should trigger the webhook. | +| active | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Indicate if the webhook should receive events. | +| configuration | OrganizationWebhookConfiguration | configuration block. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#id OrganizationWebhook#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `events`Required + +```java +public java.util.List getEvents(); +``` + +- *Type:* java.util.List + +A list of events which should trigger the webhook. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#events OrganizationWebhook#events} + +--- + +##### `active`Optional + +```java +public java.lang.Boolean|IResolvable getActive(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Indicate if the webhook should receive events. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#active OrganizationWebhook#active} + +--- + +##### `configuration`Optional + +```java +public OrganizationWebhookConfiguration getConfiguration(); +``` + +- *Type:* OrganizationWebhookConfiguration + +configuration block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#configuration OrganizationWebhook#configuration} + +--- + +##### `id`Optional + +```java +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/resources/organization_webhook#id OrganizationWebhook#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. + +--- + +### OrganizationWebhookConfiguration + +#### Initializer + +```java +import io.cdktn.providers.github.organization_webhook.OrganizationWebhookConfiguration; + +OrganizationWebhookConfiguration.builder() + .url(java.lang.String) +// .contentType(java.lang.String) +// .insecureSsl(java.lang.Boolean|IResolvable) +// .secret(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| url | java.lang.String | The URL of the webhook. | +| contentType | java.lang.String | The content type for the payload. Valid values are either 'form' or 'json'. | +| insecureSsl | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Insecure SSL boolean toggle. Defaults to 'false'. | +| secret | java.lang.String | The shared secret for the webhook. | + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +The URL of the webhook. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#url OrganizationWebhook#url} + +--- + +##### `contentType`Optional + +```java +public java.lang.String getContentType(); +``` + +- *Type:* java.lang.String + +The content type for the payload. Valid values are either 'form' or 'json'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#content_type OrganizationWebhook#content_type} + +--- + +##### `insecureSsl`Optional + +```java +public java.lang.Boolean|IResolvable getInsecureSsl(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Insecure SSL boolean toggle. Defaults to 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#insecure_ssl OrganizationWebhook#insecure_ssl} + +--- + +##### `secret`Optional + +```java +public java.lang.String getSecret(); +``` + +- *Type:* java.lang.String + +The shared secret for the webhook. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/organization_webhook#secret OrganizationWebhook#secret} + +--- + +## Classes + +### OrganizationWebhookConfigurationOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.organization_webhook.OrganizationWebhookConfigurationOutputReference; + +new OrganizationWebhookConfigurationOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetContentType | *No description.* | +| resetInsecureSsl | *No description.* | +| resetSecret | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetContentType` + +```java +public void resetContentType() +``` + +##### `resetInsecureSsl` + +```java +public void resetInsecureSsl() +``` + +##### `resetSecret` + +```java +public void resetSecret() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| contentTypeInput | java.lang.String | *No description.* | +| insecureSslInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| secretInput | java.lang.String | *No description.* | +| urlInput | java.lang.String | *No description.* | +| contentType | java.lang.String | *No description.* | +| insecureSsl | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| secret | java.lang.String | *No description.* | +| url | java.lang.String | *No description.* | +| internalValue | OrganizationWebhookConfiguration | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `contentTypeInput`Optional + +```java +public java.lang.String getContentTypeInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `insecureSslInput`Optional + +```java +public java.lang.Boolean|IResolvable getInsecureSslInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `secretInput`Optional + +```java +public java.lang.String getSecretInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `urlInput`Optional + +```java +public java.lang.String getUrlInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `contentType`Required + +```java +public java.lang.String getContentType(); +``` + +- *Type:* java.lang.String + +--- + +##### `insecureSsl`Required + +```java +public java.lang.Boolean|IResolvable getInsecureSsl(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `secret`Required + +```java +public java.lang.String getSecret(); +``` + +- *Type:* java.lang.String + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public OrganizationWebhookConfiguration getInternalValue(); +``` + +- *Type:* OrganizationWebhookConfiguration + +--- + + + diff --git a/docs/projectCard.csharp.md b/docs/projectCard.csharp.md new file mode 100644 index 000000000..d20c6508b --- /dev/null +++ b/docs/projectCard.csharp.md @@ -0,0 +1,1031 @@ +# `projectCard` Submodule + +## Constructs + +### ProjectCard + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_card github_project_card}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ProjectCard(Construct Scope, string Id, ProjectCardConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | ProjectCardConfig | *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:* ProjectCardConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetContentId | *No description.* | +| ResetContentType | *No description.* | +| ResetId | *No description.* | +| ResetNote | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetContentId` + +```csharp +private void ResetContentId() +``` + +##### `ResetContentType` + +```csharp +private void ResetContentType() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetNote` + +```csharp +private void ResetNote() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a ProjectCard resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +ProjectCard.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` + +```csharp +using Io.Cdktn.Providers.Github; + +ProjectCard.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +ProjectCard.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +ProjectCard.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a ProjectCard resource upon running "cdktn 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 ProjectCard to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing ProjectCard that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_card#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the ProjectCard to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| CardId | double | *No description.* | +| Etag | string | *No description.* | +| ColumnIdInput | string | *No description.* | +| ContentIdInput | double | *No description.* | +| ContentTypeInput | string | *No description.* | +| IdInput | string | *No description.* | +| NoteInput | string | *No description.* | +| ColumnId | string | *No description.* | +| ContentId | double | *No description.* | +| ContentType | string | *No description.* | +| Id | string | *No description.* | +| Note | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `CardId`Required + +```csharp +public double CardId { get; } +``` + +- *Type:* double + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `ColumnIdInput`Optional + +```csharp +public string ColumnIdInput { get; } +``` + +- *Type:* string + +--- + +##### `ContentIdInput`Optional + +```csharp +public double ContentIdInput { get; } +``` + +- *Type:* double + +--- + +##### `ContentTypeInput`Optional + +```csharp +public string ContentTypeInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NoteInput`Optional + +```csharp +public string NoteInput { get; } +``` + +- *Type:* string + +--- + +##### `ColumnId`Required + +```csharp +public string ColumnId { get; } +``` + +- *Type:* string + +--- + +##### `ContentId`Required + +```csharp +public double ContentId { get; } +``` + +- *Type:* double + +--- + +##### `ContentType`Required + +```csharp +public string ContentType { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Note`Required + +```csharp +public string Note { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### ProjectCardConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ProjectCardConfig { + 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 ColumnId, + double ContentId = null, + string ContentType = null, + string Id = null, + string Note = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| ColumnId | string | The ID of the project column. | +| ContentId | double | 'github_issue.issue_id'. | +| ContentType | string | Must be either 'Issue' or 'PullRequest'. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_card#id ProjectCard#id}. | +| Note | string | The note contents of the card. Markdown supported. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `ColumnId`Required + +```csharp +public string ColumnId { get; set; } +``` + +- *Type:* string + +The ID of the project column. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_card#column_id ProjectCard#column_id} + +--- + +##### `ContentId`Optional + +```csharp +public double ContentId { get; set; } +``` + +- *Type:* double + +'github_issue.issue_id'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_card#content_id ProjectCard#content_id} + +--- + +##### `ContentType`Optional + +```csharp +public string ContentType { get; set; } +``` + +- *Type:* string + +Must be either 'Issue' or 'PullRequest'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_card#content_type ProjectCard#content_type} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_card#id ProjectCard#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. + +--- + +##### `Note`Optional + +```csharp +public string Note { get; set; } +``` + +- *Type:* string + +The note contents of the card. Markdown supported. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_card#note ProjectCard#note} + +--- + + + diff --git a/docs/projectCard.java.md b/docs/projectCard.java.md new file mode 100644 index 000000000..fc477393e --- /dev/null +++ b/docs/projectCard.java.md @@ -0,0 +1,1144 @@ +# `projectCard` Submodule + +## Constructs + +### ProjectCard + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_card github_project_card}. + +#### Initializers + +```java +import io.cdktn.providers.github.project_card.ProjectCard; + +ProjectCard.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .columnId(java.lang.String) +// .contentId(java.lang.Number) +// .contentType(java.lang.String) +// .id(java.lang.String) +// .note(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 | *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 | *No description.* | +| columnId | java.lang.String | The ID of the project column. | +| contentId | java.lang.Number | 'github_issue.issue_id'. | +| contentType | java.lang.String | Must be either 'Issue' or 'PullRequest'. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_card#id ProjectCard#id}. | +| note | java.lang.String | The note contents of the card. Markdown supported. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `columnId`Required + +- *Type:* java.lang.String + +The ID of the project column. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_card#column_id ProjectCard#column_id} + +--- + +##### `contentId`Optional + +- *Type:* java.lang.Number + +'github_issue.issue_id'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_card#content_id ProjectCard#content_id} + +--- + +##### `contentType`Optional + +- *Type:* java.lang.String + +Must be either 'Issue' or 'PullRequest'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_card#content_type ProjectCard#content_type} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_card#id ProjectCard#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. + +--- + +##### `note`Optional + +- *Type:* java.lang.String + +The note contents of the card. Markdown supported. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_card#note ProjectCard#note} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetContentId | *No description.* | +| resetContentType | *No description.* | +| resetId | *No description.* | +| resetNote | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetContentId` + +```java +public void resetContentId() +``` + +##### `resetContentType` + +```java +public void resetContentType() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetNote` + +```java +public void resetNote() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a ProjectCard resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.project_card.ProjectCard; + +ProjectCard.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` + +```java +import io.cdktn.providers.github.project_card.ProjectCard; + +ProjectCard.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.project_card.ProjectCard; + +ProjectCard.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.project_card.ProjectCard; + +ProjectCard.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ProjectCard.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a ProjectCard 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 ProjectCard to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing ProjectCard that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_card#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 ProjectCard 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| cardId | java.lang.Number | *No description.* | +| etag | java.lang.String | *No description.* | +| columnIdInput | java.lang.String | *No description.* | +| contentIdInput | java.lang.Number | *No description.* | +| contentTypeInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| noteInput | java.lang.String | *No description.* | +| columnId | java.lang.String | *No description.* | +| contentId | java.lang.Number | *No description.* | +| contentType | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| note | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `cardId`Required + +```java +public java.lang.Number getCardId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `columnIdInput`Optional + +```java +public java.lang.String getColumnIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `contentIdInput`Optional + +```java +public java.lang.Number getContentIdInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `contentTypeInput`Optional + +```java +public java.lang.String getContentTypeInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `noteInput`Optional + +```java +public java.lang.String getNoteInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `columnId`Required + +```java +public java.lang.String getColumnId(); +``` + +- *Type:* java.lang.String + +--- + +##### `contentId`Required + +```java +public java.lang.Number getContentId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `contentType`Required + +```java +public java.lang.String getContentType(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `note`Required + +```java +public java.lang.String getNote(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### ProjectCardConfig + +#### Initializer + +```java +import io.cdktn.providers.github.project_card.ProjectCardConfig; + +ProjectCardConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .columnId(java.lang.String) +// .contentId(java.lang.Number) +// .contentType(java.lang.String) +// .id(java.lang.String) +// .note(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 | *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 | *No description.* | +| columnId | java.lang.String | The ID of the project column. | +| contentId | java.lang.Number | 'github_issue.issue_id'. | +| contentType | java.lang.String | Must be either 'Issue' or 'PullRequest'. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_card#id ProjectCard#id}. | +| note | java.lang.String | The note contents of the card. Markdown supported. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `columnId`Required + +```java +public java.lang.String getColumnId(); +``` + +- *Type:* java.lang.String + +The ID of the project column. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_card#column_id ProjectCard#column_id} + +--- + +##### `contentId`Optional + +```java +public java.lang.Number getContentId(); +``` + +- *Type:* java.lang.Number + +'github_issue.issue_id'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_card#content_id ProjectCard#content_id} + +--- + +##### `contentType`Optional + +```java +public java.lang.String getContentType(); +``` + +- *Type:* java.lang.String + +Must be either 'Issue' or 'PullRequest'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_card#content_type ProjectCard#content_type} + +--- + +##### `id`Optional + +```java +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/resources/project_card#id ProjectCard#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. + +--- + +##### `note`Optional + +```java +public java.lang.String getNote(); +``` + +- *Type:* java.lang.String + +The note contents of the card. Markdown supported. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_card#note ProjectCard#note} + +--- + + + diff --git a/docs/projectColumn.csharp.md b/docs/projectColumn.csharp.md new file mode 100644 index 000000000..b6eee2957 --- /dev/null +++ b/docs/projectColumn.csharp.md @@ -0,0 +1,934 @@ +# `projectColumn` Submodule + +## Constructs + +### ProjectColumn + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_column github_project_column}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new ProjectColumn(Construct Scope, string Id, ProjectColumnConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | ProjectColumnConfig | *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:* ProjectColumnConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a ProjectColumn resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +ProjectColumn.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` + +```csharp +using Io.Cdktn.Providers.Github; + +ProjectColumn.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +ProjectColumn.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +ProjectColumn.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a ProjectColumn resource upon running "cdktn 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 ProjectColumn to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing ProjectColumn that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_column#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the ProjectColumn to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| ColumnId | double | *No description.* | +| Etag | string | *No description.* | +| IdInput | string | *No description.* | +| NameInput | string | *No description.* | +| ProjectIdInput | string | *No description.* | +| Id | string | *No description.* | +| Name | string | *No description.* | +| ProjectId | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `ColumnId`Required + +```csharp +public double ColumnId { get; } +``` + +- *Type:* double + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `ProjectIdInput`Optional + +```csharp +public string ProjectIdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `ProjectId`Required + +```csharp +public string ProjectId { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### ProjectColumnConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ProjectColumnConfig { + 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 Name, + string ProjectId, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Name | string | The name of the column. | +| ProjectId | string | The ID of an existing project that the column will be created in. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_column#id ProjectColumn#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Name`Required + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +The name of the column. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_column#name ProjectColumn#name} + +--- + +##### `ProjectId`Required + +```csharp +public string ProjectId { get; set; } +``` + +- *Type:* string + +The ID of an existing project that the column will be created in. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_column#project_id ProjectColumn#project_id} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_column#id ProjectColumn#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. + +--- + + + diff --git a/docs/projectColumn.java.md b/docs/projectColumn.java.md new file mode 100644 index 000000000..93bc94939 --- /dev/null +++ b/docs/projectColumn.java.md @@ -0,0 +1,1023 @@ +# `projectColumn` Submodule + +## Constructs + +### ProjectColumn + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_column github_project_column}. + +#### Initializers + +```java +import io.cdktn.providers.github.project_column.ProjectColumn; + +ProjectColumn.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .name(java.lang.String) + .projectId(java.lang.String) +// .id(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 | *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 | *No description.* | +| name | java.lang.String | The name of the column. | +| projectId | java.lang.String | The ID of an existing project that the column will be created in. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_column#id ProjectColumn#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `name`Required + +- *Type:* java.lang.String + +The name of the column. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_column#name ProjectColumn#name} + +--- + +##### `projectId`Required + +- *Type:* java.lang.String + +The ID of an existing project that the column will be created in. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_column#project_id ProjectColumn#project_id} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_column#id ProjectColumn#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a ProjectColumn resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.project_column.ProjectColumn; + +ProjectColumn.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` + +```java +import io.cdktn.providers.github.project_column.ProjectColumn; + +ProjectColumn.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.project_column.ProjectColumn; + +ProjectColumn.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.project_column.ProjectColumn; + +ProjectColumn.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ProjectColumn.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a ProjectColumn 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 ProjectColumn to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing ProjectColumn that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_column#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 ProjectColumn 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| columnId | java.lang.Number | *No description.* | +| etag | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| projectIdInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| projectId | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `columnId`Required + +```java +public java.lang.Number getColumnId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `projectIdInput`Optional + +```java +public java.lang.String getProjectIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `projectId`Required + +```java +public java.lang.String getProjectId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### ProjectColumnConfig + +#### Initializer + +```java +import io.cdktn.providers.github.project_column.ProjectColumnConfig; + +ProjectColumnConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .name(java.lang.String) + .projectId(java.lang.String) +// .id(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 | *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 | *No description.* | +| name | java.lang.String | The name of the column. | +| projectId | java.lang.String | The ID of an existing project that the column will be created in. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_column#id ProjectColumn#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +The name of the column. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_column#name ProjectColumn#name} + +--- + +##### `projectId`Required + +```java +public java.lang.String getProjectId(); +``` + +- *Type:* java.lang.String + +The ID of an existing project that the column will be created in. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/project_column#project_id ProjectColumn#project_id} + +--- + +##### `id`Optional + +```java +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/resources/project_column#id ProjectColumn#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. + +--- + + + diff --git a/docs/provider.csharp.md b/docs/provider.csharp.md new file mode 100644 index 000000000..c310108d5 --- /dev/null +++ b/docs/provider.csharp.md @@ -0,0 +1,1115 @@ +# `provider` Submodule + +## Constructs + +### GithubProvider + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs github}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new GithubProvider(Construct Scope, string Id, GithubProviderConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | GithubProviderConfig | *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`Optional + +- *Type:* GithubProviderConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| ResetAlias | *No description.* | +| ResetAppAuth | *No description.* | +| ResetBaseUrl | *No description.* | +| ResetInsecure | *No description.* | +| ResetMaxPerPage | *No description.* | +| ResetMaxRetries | *No description.* | +| ResetOrganization | *No description.* | +| ResetOwner | *No description.* | +| ResetParallelRequests | *No description.* | +| ResetReadDelayMs | *No description.* | +| ResetRetryableErrors | *No description.* | +| ResetRetryDelayMs | *No description.* | +| ResetToken | *No description.* | +| ResetWriteDelayMs | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `ResetAlias` + +```csharp +private void ResetAlias() +``` + +##### `ResetAppAuth` + +```csharp +private void ResetAppAuth() +``` + +##### `ResetBaseUrl` + +```csharp +private void ResetBaseUrl() +``` + +##### `ResetInsecure` + +```csharp +private void ResetInsecure() +``` + +##### `ResetMaxPerPage` + +```csharp +private void ResetMaxPerPage() +``` + +##### `ResetMaxRetries` + +```csharp +private void ResetMaxRetries() +``` + +##### `ResetOrganization` + +```csharp +private void ResetOrganization() +``` + +##### `ResetOwner` + +```csharp +private void ResetOwner() +``` + +##### `ResetParallelRequests` + +```csharp +private void ResetParallelRequests() +``` + +##### `ResetReadDelayMs` + +```csharp +private void ResetReadDelayMs() +``` + +##### `ResetRetryableErrors` + +```csharp +private void ResetRetryableErrors() +``` + +##### `ResetRetryDelayMs` + +```csharp +private void ResetRetryDelayMs() +``` + +##### `ResetToken` + +```csharp +private void ResetToken() +``` + +##### `ResetWriteDelayMs` + +```csharp +private void ResetWriteDelayMs() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformProvider | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a GithubProvider resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +GithubProvider.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` + +```csharp +using Io.Cdktn.Providers.Github; + +GithubProvider.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformProvider` + +```csharp +using Io.Cdktn.Providers.Github; + +GithubProvider.IsTerraformProvider(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +GithubProvider.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a GithubProvider resource upon running "cdktn 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 GithubProvider to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing GithubProvider that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the GithubProvider to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| MetaAttributes | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| TerraformProviderSource | string | *No description.* | +| Alias | string | *No description.* | +| AliasInput | string | *No description.* | +| AppAuthInput | GithubProviderAppAuth | *No description.* | +| BaseUrlInput | string | *No description.* | +| InsecureInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| MaxPerPageInput | double | *No description.* | +| MaxRetriesInput | double | *No description.* | +| OrganizationInput | string | *No description.* | +| OwnerInput | string | *No description.* | +| ParallelRequestsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| ReadDelayMsInput | double | *No description.* | +| RetryableErrorsInput | double[] | *No description.* | +| RetryDelayMsInput | double | *No description.* | +| TokenInput | string | *No description.* | +| WriteDelayMsInput | double | *No description.* | +| AppAuth | GithubProviderAppAuth | *No description.* | +| BaseUrl | string | *No description.* | +| Insecure | bool\|Io.Cdktn.IResolvable | *No description.* | +| MaxPerPage | double | *No description.* | +| MaxRetries | double | *No description.* | +| Organization | string | *No description.* | +| Owner | string | *No description.* | +| ParallelRequests | bool\|Io.Cdktn.IResolvable | *No description.* | +| ReadDelayMs | double | *No description.* | +| RetryableErrors | double[] | *No description.* | +| RetryDelayMs | double | *No description.* | +| Token | string | *No description.* | +| WriteDelayMs | double | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `MetaAttributes`Required + +```csharp +public System.Collections.Generic.IDictionary MetaAttributes { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `TerraformProviderSource`Optional + +```csharp +public string TerraformProviderSource { get; } +``` + +- *Type:* string + +--- + +##### `Alias`Optional + +```csharp +public string Alias { get; } +``` + +- *Type:* string + +--- + +##### `AliasInput`Optional + +```csharp +public string AliasInput { get; } +``` + +- *Type:* string + +--- + +##### `AppAuthInput`Optional + +```csharp +public GithubProviderAppAuth AppAuthInput { get; } +``` + +- *Type:* GithubProviderAppAuth + +--- + +##### `BaseUrlInput`Optional + +```csharp +public string BaseUrlInput { get; } +``` + +- *Type:* string + +--- + +##### `InsecureInput`Optional + +```csharp +public bool|IResolvable InsecureInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `MaxPerPageInput`Optional + +```csharp +public double MaxPerPageInput { get; } +``` + +- *Type:* double + +--- + +##### `MaxRetriesInput`Optional + +```csharp +public double MaxRetriesInput { get; } +``` + +- *Type:* double + +--- + +##### `OrganizationInput`Optional + +```csharp +public string OrganizationInput { get; } +``` + +- *Type:* string + +--- + +##### `OwnerInput`Optional + +```csharp +public string OwnerInput { get; } +``` + +- *Type:* string + +--- + +##### `ParallelRequestsInput`Optional + +```csharp +public bool|IResolvable ParallelRequestsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ReadDelayMsInput`Optional + +```csharp +public double ReadDelayMsInput { get; } +``` + +- *Type:* double + +--- + +##### `RetryableErrorsInput`Optional + +```csharp +public double[] RetryableErrorsInput { get; } +``` + +- *Type:* double[] + +--- + +##### `RetryDelayMsInput`Optional + +```csharp +public double RetryDelayMsInput { get; } +``` + +- *Type:* double + +--- + +##### `TokenInput`Optional + +```csharp +public string TokenInput { get; } +``` + +- *Type:* string + +--- + +##### `WriteDelayMsInput`Optional + +```csharp +public double WriteDelayMsInput { get; } +``` + +- *Type:* double + +--- + +##### `AppAuth`Optional + +```csharp +public GithubProviderAppAuth AppAuth { get; } +``` + +- *Type:* GithubProviderAppAuth + +--- + +##### `BaseUrl`Optional + +```csharp +public string BaseUrl { get; } +``` + +- *Type:* string + +--- + +##### `Insecure`Optional + +```csharp +public bool|IResolvable Insecure { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `MaxPerPage`Optional + +```csharp +public double MaxPerPage { get; } +``` + +- *Type:* double + +--- + +##### `MaxRetries`Optional + +```csharp +public double MaxRetries { get; } +``` + +- *Type:* double + +--- + +##### `Organization`Optional + +```csharp +public string Organization { get; } +``` + +- *Type:* string + +--- + +##### `Owner`Optional + +```csharp +public string Owner { get; } +``` + +- *Type:* string + +--- + +##### `ParallelRequests`Optional + +```csharp +public bool|IResolvable ParallelRequests { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ReadDelayMs`Optional + +```csharp +public double ReadDelayMs { get; } +``` + +- *Type:* double + +--- + +##### `RetryableErrors`Optional + +```csharp +public double[] RetryableErrors { get; } +``` + +- *Type:* double[] + +--- + +##### `RetryDelayMs`Optional + +```csharp +public double RetryDelayMs { get; } +``` + +- *Type:* double + +--- + +##### `Token`Optional + +```csharp +public string Token { get; } +``` + +- *Type:* string + +--- + +##### `WriteDelayMs`Optional + +```csharp +public double WriteDelayMs { get; } +``` + +- *Type:* double + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### GithubProviderAppAuth + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new GithubProviderAppAuth { + string Id, + string InstallationId, + string PemFile +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Id | string | The GitHub App ID. | +| InstallationId | string | The GitHub App installation instance ID. | +| PemFile | string | The GitHub App PEM file contents. | + +--- + +##### `Id`Required + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +The GitHub App ID. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#id GithubProvider#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. + +--- + +##### `InstallationId`Required + +```csharp +public string InstallationId { get; set; } +``` + +- *Type:* string + +The GitHub App installation instance ID. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#installation_id GithubProvider#installation_id} + +--- + +##### `PemFile`Required + +```csharp +public string PemFile { get; set; } +``` + +- *Type:* string + +The GitHub App PEM file contents. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#pem_file GithubProvider#pem_file} + +--- + +### GithubProviderConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new GithubProviderConfig { + string Alias = null, + GithubProviderAppAuth AppAuth = null, + string BaseUrl = null, + bool|IResolvable Insecure = null, + double MaxPerPage = null, + double MaxRetries = null, + string Organization = null, + string Owner = null, + bool|IResolvable ParallelRequests = null, + double ReadDelayMs = null, + double[] RetryableErrors = null, + double RetryDelayMs = null, + string Token = null, + double WriteDelayMs = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Alias | string | Alias name. | +| AppAuth | GithubProviderAppAuth | app_auth block. | +| BaseUrl | string | The GitHub Base API URL. | +| Insecure | bool\|Io.Cdktn.IResolvable | Enable `insecure` mode for testing purposes. | +| MaxPerPage | double | Number of items per page for paginationDefaults to 100. | +| MaxRetries | double | Number of times to retry a request after receiving an error status codeDefaults to 3. | +| Organization | string | The GitHub organization name to manage. Use this field instead of `owner` when managing organization accounts. | +| Owner | string | The GitHub owner name to manage. Use this field instead of `organization` when managing individual accounts. | +| ParallelRequests | bool\|Io.Cdktn.IResolvable | Allow the provider to make parallel API calls to GitHub. | +| ReadDelayMs | double | Amount of time in milliseconds to sleep in between non-write requests to GitHub API. | +| RetryableErrors | double[] | Allow the provider to retry after receiving an error status code, the max_retries should be set for this to workDefaults to [500, 502, 503, 504]. | +| RetryDelayMs | double | Amount of time in milliseconds to sleep in between requests to GitHub API after an error response. | +| Token | string | The OAuth token used to connect to GitHub. | +| WriteDelayMs | double | Amount of time in milliseconds to sleep in between writes to GitHub API. | + +--- + +##### `Alias`Optional + +```csharp +public string Alias { get; set; } +``` + +- *Type:* string + +Alias name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#alias GithubProvider#alias} + +--- + +##### `AppAuth`Optional + +```csharp +public GithubProviderAppAuth AppAuth { get; set; } +``` + +- *Type:* GithubProviderAppAuth + +app_auth block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#app_auth GithubProvider#app_auth} + +--- + +##### `BaseUrl`Optional + +```csharp +public string BaseUrl { get; set; } +``` + +- *Type:* string + +The GitHub Base API URL. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#base_url GithubProvider#base_url} + +--- + +##### `Insecure`Optional + +```csharp +public bool|IResolvable Insecure { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Enable `insecure` mode for testing purposes. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#insecure GithubProvider#insecure} + +--- + +##### `MaxPerPage`Optional + +```csharp +public double MaxPerPage { get; set; } +``` + +- *Type:* double + +Number of items per page for paginationDefaults to 100. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#max_per_page GithubProvider#max_per_page} + +--- + +##### `MaxRetries`Optional + +```csharp +public double MaxRetries { get; set; } +``` + +- *Type:* double + +Number of times to retry a request after receiving an error status codeDefaults to 3. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#max_retries GithubProvider#max_retries} + +--- + +##### `Organization`Optional + +```csharp +public string Organization { get; set; } +``` + +- *Type:* string + +The GitHub organization name to manage. Use this field instead of `owner` when managing organization accounts. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#organization GithubProvider#organization} + +--- + +##### `Owner`Optional + +```csharp +public string Owner { get; set; } +``` + +- *Type:* string + +The GitHub owner name to manage. Use this field instead of `organization` when managing individual accounts. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#owner GithubProvider#owner} + +--- + +##### `ParallelRequests`Optional + +```csharp +public bool|IResolvable ParallelRequests { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Allow the provider to make parallel API calls to GitHub. + +You may want to set it to true when you have a private Github Enterprise without strict rate limits. While it is possible to enable this setting on github.com, github.com's best practices recommend using serialization to avoid hitting abuse rate limitsDefaults to false if not set + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#parallel_requests GithubProvider#parallel_requests} + +--- + +##### `ReadDelayMs`Optional + +```csharp +public double ReadDelayMs { get; set; } +``` + +- *Type:* double + +Amount of time in milliseconds to sleep in between non-write requests to GitHub API. + +Defaults to 0ms if not set. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#read_delay_ms GithubProvider#read_delay_ms} + +--- + +##### `RetryableErrors`Optional + +```csharp +public double[] RetryableErrors { get; set; } +``` + +- *Type:* double[] + +Allow the provider to retry after receiving an error status code, the max_retries should be set for this to workDefaults to [500, 502, 503, 504]. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#retryable_errors GithubProvider#retryable_errors} + +--- + +##### `RetryDelayMs`Optional + +```csharp +public double RetryDelayMs { get; set; } +``` + +- *Type:* double + +Amount of time in milliseconds to sleep in between requests to GitHub API after an error response. + +Defaults to 1000ms or 1s if not set, the max_retries must be set to greater than zero. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#retry_delay_ms GithubProvider#retry_delay_ms} + +--- + +##### `Token`Optional + +```csharp +public string Token { get; set; } +``` + +- *Type:* string + +The OAuth token used to connect to GitHub. + +Anonymous mode is enabled if both `token` and `app_auth` are not set. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#token GithubProvider#token} + +--- + +##### `WriteDelayMs`Optional + +```csharp +public double WriteDelayMs { get; set; } +``` + +- *Type:* double + +Amount of time in milliseconds to sleep in between writes to GitHub API. + +Defaults to 1000ms or 1s if not set. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#write_delay_ms GithubProvider#write_delay_ms} + +--- + + + diff --git a/docs/provider.java.md b/docs/provider.java.md new file mode 100644 index 000000000..ea7bdb917 --- /dev/null +++ b/docs/provider.java.md @@ -0,0 +1,1287 @@ +# `provider` Submodule + +## Constructs + +### GithubProvider + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs github}. + +#### Initializers + +```java +import io.cdktn.providers.github.provider.GithubProvider; + +GithubProvider.Builder.create(Construct scope, java.lang.String id) +// .alias(java.lang.String) +// .appAuth(GithubProviderAppAuth) +// .baseUrl(java.lang.String) +// .insecure(java.lang.Boolean|IResolvable) +// .maxPerPage(java.lang.Number) +// .maxRetries(java.lang.Number) +// .organization(java.lang.String) +// .owner(java.lang.String) +// .parallelRequests(java.lang.Boolean|IResolvable) +// .readDelayMs(java.lang.Number) +// .retryableErrors(java.util.List) +// .retryDelayMs(java.lang.Number) +// .token(java.lang.String) +// .writeDelayMs(java.lang.Number) + .build(); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | software.constructs.Construct | The scope in which to define this construct. | +| id | java.lang.String | The scoped construct ID. | +| alias | java.lang.String | Alias name. | +| appAuth | GithubProviderAppAuth | app_auth block. | +| baseUrl | java.lang.String | The GitHub Base API URL. | +| insecure | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Enable `insecure` mode for testing purposes. | +| maxPerPage | java.lang.Number | Number of items per page for paginationDefaults to 100. | +| maxRetries | java.lang.Number | Number of times to retry a request after receiving an error status codeDefaults to 3. | +| organization | java.lang.String | The GitHub organization name to manage. Use this field instead of `owner` when managing organization accounts. | +| owner | java.lang.String | The GitHub owner name to manage. Use this field instead of `organization` when managing individual accounts. | +| parallelRequests | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Allow the provider to make parallel API calls to GitHub. | +| readDelayMs | java.lang.Number | Amount of time in milliseconds to sleep in between non-write requests to GitHub API. | +| retryableErrors | java.util.List | Allow the provider to retry after receiving an error status code, the max_retries should be set for this to workDefaults to [500, 502, 503, 504]. | +| retryDelayMs | java.lang.Number | Amount of time in milliseconds to sleep in between requests to GitHub API after an error response. | +| token | java.lang.String | The OAuth token used to connect to GitHub. | +| writeDelayMs | java.lang.Number | Amount of time in milliseconds to sleep in between writes to GitHub API. | + +--- + +##### `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 + +--- + +##### `alias`Optional + +- *Type:* java.lang.String + +Alias name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#alias GithubProvider#alias} + +--- + +##### `appAuth`Optional + +- *Type:* GithubProviderAppAuth + +app_auth block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#app_auth GithubProvider#app_auth} + +--- + +##### `baseUrl`Optional + +- *Type:* java.lang.String + +The GitHub Base API URL. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#base_url GithubProvider#base_url} + +--- + +##### `insecure`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Enable `insecure` mode for testing purposes. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#insecure GithubProvider#insecure} + +--- + +##### `maxPerPage`Optional + +- *Type:* java.lang.Number + +Number of items per page for paginationDefaults to 100. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#max_per_page GithubProvider#max_per_page} + +--- + +##### `maxRetries`Optional + +- *Type:* java.lang.Number + +Number of times to retry a request after receiving an error status codeDefaults to 3. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#max_retries GithubProvider#max_retries} + +--- + +##### `organization`Optional + +- *Type:* java.lang.String + +The GitHub organization name to manage. Use this field instead of `owner` when managing organization accounts. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#organization GithubProvider#organization} + +--- + +##### `owner`Optional + +- *Type:* java.lang.String + +The GitHub owner name to manage. Use this field instead of `organization` when managing individual accounts. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#owner GithubProvider#owner} + +--- + +##### `parallelRequests`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Allow the provider to make parallel API calls to GitHub. + +You may want to set it to true when you have a private Github Enterprise without strict rate limits. While it is possible to enable this setting on github.com, github.com's best practices recommend using serialization to avoid hitting abuse rate limitsDefaults to false if not set + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#parallel_requests GithubProvider#parallel_requests} + +--- + +##### `readDelayMs`Optional + +- *Type:* java.lang.Number + +Amount of time in milliseconds to sleep in between non-write requests to GitHub API. + +Defaults to 0ms if not set. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#read_delay_ms GithubProvider#read_delay_ms} + +--- + +##### `retryableErrors`Optional + +- *Type:* java.util.List + +Allow the provider to retry after receiving an error status code, the max_retries should be set for this to workDefaults to [500, 502, 503, 504]. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#retryable_errors GithubProvider#retryable_errors} + +--- + +##### `retryDelayMs`Optional + +- *Type:* java.lang.Number + +Amount of time in milliseconds to sleep in between requests to GitHub API after an error response. + +Defaults to 1000ms or 1s if not set, the max_retries must be set to greater than zero. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#retry_delay_ms GithubProvider#retry_delay_ms} + +--- + +##### `token`Optional + +- *Type:* java.lang.String + +The OAuth token used to connect to GitHub. + +Anonymous mode is enabled if both `token` and `app_auth` are not set. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#token GithubProvider#token} + +--- + +##### `writeDelayMs`Optional + +- *Type:* java.lang.Number + +Amount of time in milliseconds to sleep in between writes to GitHub API. + +Defaults to 1000ms or 1s if not set. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#write_delay_ms GithubProvider#write_delay_ms} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| resetAlias | *No description.* | +| resetAppAuth | *No description.* | +| resetBaseUrl | *No description.* | +| resetInsecure | *No description.* | +| resetMaxPerPage | *No description.* | +| resetMaxRetries | *No description.* | +| resetOrganization | *No description.* | +| resetOwner | *No description.* | +| resetParallelRequests | *No description.* | +| resetReadDelayMs | *No description.* | +| resetRetryableErrors | *No description.* | +| resetRetryDelayMs | *No description.* | +| resetToken | *No description.* | +| resetWriteDelayMs | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `resetAlias` + +```java +public void resetAlias() +``` + +##### `resetAppAuth` + +```java +public void resetAppAuth() +``` + +##### `resetBaseUrl` + +```java +public void resetBaseUrl() +``` + +##### `resetInsecure` + +```java +public void resetInsecure() +``` + +##### `resetMaxPerPage` + +```java +public void resetMaxPerPage() +``` + +##### `resetMaxRetries` + +```java +public void resetMaxRetries() +``` + +##### `resetOrganization` + +```java +public void resetOrganization() +``` + +##### `resetOwner` + +```java +public void resetOwner() +``` + +##### `resetParallelRequests` + +```java +public void resetParallelRequests() +``` + +##### `resetReadDelayMs` + +```java +public void resetReadDelayMs() +``` + +##### `resetRetryableErrors` + +```java +public void resetRetryableErrors() +``` + +##### `resetRetryDelayMs` + +```java +public void resetRetryDelayMs() +``` + +##### `resetToken` + +```java +public void resetToken() +``` + +##### `resetWriteDelayMs` + +```java +public void resetWriteDelayMs() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformProvider | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a GithubProvider resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.provider.GithubProvider; + +GithubProvider.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` + +```java +import io.cdktn.providers.github.provider.GithubProvider; + +GithubProvider.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformProvider` + +```java +import io.cdktn.providers.github.provider.GithubProvider; + +GithubProvider.isTerraformProvider(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.provider.GithubProvider; + +GithubProvider.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),GithubProvider.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a GithubProvider 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 GithubProvider to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing GithubProvider that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#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 GithubProvider 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.* | +| metaAttributes | java.util.Map | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| terraformProviderSource | java.lang.String | *No description.* | +| alias | java.lang.String | *No description.* | +| aliasInput | java.lang.String | *No description.* | +| appAuthInput | GithubProviderAppAuth | *No description.* | +| baseUrlInput | java.lang.String | *No description.* | +| insecureInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| maxPerPageInput | java.lang.Number | *No description.* | +| maxRetriesInput | java.lang.Number | *No description.* | +| organizationInput | java.lang.String | *No description.* | +| ownerInput | java.lang.String | *No description.* | +| parallelRequestsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| readDelayMsInput | java.lang.Number | *No description.* | +| retryableErrorsInput | java.util.List | *No description.* | +| retryDelayMsInput | java.lang.Number | *No description.* | +| tokenInput | java.lang.String | *No description.* | +| writeDelayMsInput | java.lang.Number | *No description.* | +| appAuth | GithubProviderAppAuth | *No description.* | +| baseUrl | java.lang.String | *No description.* | +| insecure | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| maxPerPage | java.lang.Number | *No description.* | +| maxRetries | java.lang.Number | *No description.* | +| organization | java.lang.String | *No description.* | +| owner | java.lang.String | *No description.* | +| parallelRequests | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| readDelayMs | java.lang.Number | *No description.* | +| retryableErrors | java.util.List | *No description.* | +| retryDelayMs | java.lang.Number | *No description.* | +| token | java.lang.String | *No description.* | +| writeDelayMs | java.lang.Number | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `metaAttributes`Required + +```java +public java.util.Map getMetaAttributes(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `terraformProviderSource`Optional + +```java +public java.lang.String getTerraformProviderSource(); +``` + +- *Type:* java.lang.String + +--- + +##### `alias`Optional + +```java +public java.lang.String getAlias(); +``` + +- *Type:* java.lang.String + +--- + +##### `aliasInput`Optional + +```java +public java.lang.String getAliasInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `appAuthInput`Optional + +```java +public GithubProviderAppAuth getAppAuthInput(); +``` + +- *Type:* GithubProviderAppAuth + +--- + +##### `baseUrlInput`Optional + +```java +public java.lang.String getBaseUrlInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `insecureInput`Optional + +```java +public java.lang.Boolean|IResolvable getInsecureInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `maxPerPageInput`Optional + +```java +public java.lang.Number getMaxPerPageInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `maxRetriesInput`Optional + +```java +public java.lang.Number getMaxRetriesInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `organizationInput`Optional + +```java +public java.lang.String getOrganizationInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `ownerInput`Optional + +```java +public java.lang.String getOwnerInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `parallelRequestsInput`Optional + +```java +public java.lang.Boolean|IResolvable getParallelRequestsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `readDelayMsInput`Optional + +```java +public java.lang.Number getReadDelayMsInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `retryableErrorsInput`Optional + +```java +public java.util.List getRetryableErrorsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `retryDelayMsInput`Optional + +```java +public java.lang.Number getRetryDelayMsInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `tokenInput`Optional + +```java +public java.lang.String getTokenInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `writeDelayMsInput`Optional + +```java +public java.lang.Number getWriteDelayMsInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `appAuth`Optional + +```java +public GithubProviderAppAuth getAppAuth(); +``` + +- *Type:* GithubProviderAppAuth + +--- + +##### `baseUrl`Optional + +```java +public java.lang.String getBaseUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `insecure`Optional + +```java +public java.lang.Boolean|IResolvable getInsecure(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `maxPerPage`Optional + +```java +public java.lang.Number getMaxPerPage(); +``` + +- *Type:* java.lang.Number + +--- + +##### `maxRetries`Optional + +```java +public java.lang.Number getMaxRetries(); +``` + +- *Type:* java.lang.Number + +--- + +##### `organization`Optional + +```java +public java.lang.String getOrganization(); +``` + +- *Type:* java.lang.String + +--- + +##### `owner`Optional + +```java +public java.lang.String getOwner(); +``` + +- *Type:* java.lang.String + +--- + +##### `parallelRequests`Optional + +```java +public java.lang.Boolean|IResolvable getParallelRequests(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `readDelayMs`Optional + +```java +public java.lang.Number getReadDelayMs(); +``` + +- *Type:* java.lang.Number + +--- + +##### `retryableErrors`Optional + +```java +public java.util.List getRetryableErrors(); +``` + +- *Type:* java.util.List + +--- + +##### `retryDelayMs`Optional + +```java +public java.lang.Number getRetryDelayMs(); +``` + +- *Type:* java.lang.Number + +--- + +##### `token`Optional + +```java +public java.lang.String getToken(); +``` + +- *Type:* java.lang.String + +--- + +##### `writeDelayMs`Optional + +```java +public java.lang.Number getWriteDelayMs(); +``` + +- *Type:* java.lang.Number + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### GithubProviderAppAuth + +#### Initializer + +```java +import io.cdktn.providers.github.provider.GithubProviderAppAuth; + +GithubProviderAppAuth.builder() + .id(java.lang.String) + .installationId(java.lang.String) + .pemFile(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| id | java.lang.String | The GitHub App ID. | +| installationId | java.lang.String | The GitHub App installation instance ID. | +| pemFile | java.lang.String | The GitHub App PEM file contents. | + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +The GitHub App ID. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#id GithubProvider#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. + +--- + +##### `installationId`Required + +```java +public java.lang.String getInstallationId(); +``` + +- *Type:* java.lang.String + +The GitHub App installation instance ID. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#installation_id GithubProvider#installation_id} + +--- + +##### `pemFile`Required + +```java +public java.lang.String getPemFile(); +``` + +- *Type:* java.lang.String + +The GitHub App PEM file contents. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#pem_file GithubProvider#pem_file} + +--- + +### GithubProviderConfig + +#### Initializer + +```java +import io.cdktn.providers.github.provider.GithubProviderConfig; + +GithubProviderConfig.builder() +// .alias(java.lang.String) +// .appAuth(GithubProviderAppAuth) +// .baseUrl(java.lang.String) +// .insecure(java.lang.Boolean|IResolvable) +// .maxPerPage(java.lang.Number) +// .maxRetries(java.lang.Number) +// .organization(java.lang.String) +// .owner(java.lang.String) +// .parallelRequests(java.lang.Boolean|IResolvable) +// .readDelayMs(java.lang.Number) +// .retryableErrors(java.util.List) +// .retryDelayMs(java.lang.Number) +// .token(java.lang.String) +// .writeDelayMs(java.lang.Number) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| alias | java.lang.String | Alias name. | +| appAuth | GithubProviderAppAuth | app_auth block. | +| baseUrl | java.lang.String | The GitHub Base API URL. | +| insecure | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Enable `insecure` mode for testing purposes. | +| maxPerPage | java.lang.Number | Number of items per page for paginationDefaults to 100. | +| maxRetries | java.lang.Number | Number of times to retry a request after receiving an error status codeDefaults to 3. | +| organization | java.lang.String | The GitHub organization name to manage. Use this field instead of `owner` when managing organization accounts. | +| owner | java.lang.String | The GitHub owner name to manage. Use this field instead of `organization` when managing individual accounts. | +| parallelRequests | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Allow the provider to make parallel API calls to GitHub. | +| readDelayMs | java.lang.Number | Amount of time in milliseconds to sleep in between non-write requests to GitHub API. | +| retryableErrors | java.util.List | Allow the provider to retry after receiving an error status code, the max_retries should be set for this to workDefaults to [500, 502, 503, 504]. | +| retryDelayMs | java.lang.Number | Amount of time in milliseconds to sleep in between requests to GitHub API after an error response. | +| token | java.lang.String | The OAuth token used to connect to GitHub. | +| writeDelayMs | java.lang.Number | Amount of time in milliseconds to sleep in between writes to GitHub API. | + +--- + +##### `alias`Optional + +```java +public java.lang.String getAlias(); +``` + +- *Type:* java.lang.String + +Alias name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#alias GithubProvider#alias} + +--- + +##### `appAuth`Optional + +```java +public GithubProviderAppAuth getAppAuth(); +``` + +- *Type:* GithubProviderAppAuth + +app_auth block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#app_auth GithubProvider#app_auth} + +--- + +##### `baseUrl`Optional + +```java +public java.lang.String getBaseUrl(); +``` + +- *Type:* java.lang.String + +The GitHub Base API URL. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#base_url GithubProvider#base_url} + +--- + +##### `insecure`Optional + +```java +public java.lang.Boolean|IResolvable getInsecure(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Enable `insecure` mode for testing purposes. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#insecure GithubProvider#insecure} + +--- + +##### `maxPerPage`Optional + +```java +public java.lang.Number getMaxPerPage(); +``` + +- *Type:* java.lang.Number + +Number of items per page for paginationDefaults to 100. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#max_per_page GithubProvider#max_per_page} + +--- + +##### `maxRetries`Optional + +```java +public java.lang.Number getMaxRetries(); +``` + +- *Type:* java.lang.Number + +Number of times to retry a request after receiving an error status codeDefaults to 3. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#max_retries GithubProvider#max_retries} + +--- + +##### `organization`Optional + +```java +public java.lang.String getOrganization(); +``` + +- *Type:* java.lang.String + +The GitHub organization name to manage. Use this field instead of `owner` when managing organization accounts. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#organization GithubProvider#organization} + +--- + +##### `owner`Optional + +```java +public java.lang.String getOwner(); +``` + +- *Type:* java.lang.String + +The GitHub owner name to manage. Use this field instead of `organization` when managing individual accounts. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#owner GithubProvider#owner} + +--- + +##### `parallelRequests`Optional + +```java +public java.lang.Boolean|IResolvable getParallelRequests(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Allow the provider to make parallel API calls to GitHub. + +You may want to set it to true when you have a private Github Enterprise without strict rate limits. While it is possible to enable this setting on github.com, github.com's best practices recommend using serialization to avoid hitting abuse rate limitsDefaults to false if not set + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#parallel_requests GithubProvider#parallel_requests} + +--- + +##### `readDelayMs`Optional + +```java +public java.lang.Number getReadDelayMs(); +``` + +- *Type:* java.lang.Number + +Amount of time in milliseconds to sleep in between non-write requests to GitHub API. + +Defaults to 0ms if not set. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#read_delay_ms GithubProvider#read_delay_ms} + +--- + +##### `retryableErrors`Optional + +```java +public java.util.List getRetryableErrors(); +``` + +- *Type:* java.util.List + +Allow the provider to retry after receiving an error status code, the max_retries should be set for this to workDefaults to [500, 502, 503, 504]. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#retryable_errors GithubProvider#retryable_errors} + +--- + +##### `retryDelayMs`Optional + +```java +public java.lang.Number getRetryDelayMs(); +``` + +- *Type:* java.lang.Number + +Amount of time in milliseconds to sleep in between requests to GitHub API after an error response. + +Defaults to 1000ms or 1s if not set, the max_retries must be set to greater than zero. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#retry_delay_ms GithubProvider#retry_delay_ms} + +--- + +##### `token`Optional + +```java +public java.lang.String getToken(); +``` + +- *Type:* java.lang.String + +The OAuth token used to connect to GitHub. + +Anonymous mode is enabled if both `token` and `app_auth` are not set. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#token GithubProvider#token} + +--- + +##### `writeDelayMs`Optional + +```java +public java.lang.Number getWriteDelayMs(); +``` + +- *Type:* java.lang.Number + +Amount of time in milliseconds to sleep in between writes to GitHub API. + +Defaults to 1000ms or 1s if not set. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs#write_delay_ms GithubProvider#write_delay_ms} + +--- + + + diff --git a/docs/release.csharp.md b/docs/release.csharp.md new file mode 100644 index 000000000..273f835b3 --- /dev/null +++ b/docs/release.csharp.md @@ -0,0 +1,1352 @@ +# `release` Submodule + +## Constructs + +### Release + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release github_release}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new Release(Construct Scope, string Id, ReleaseConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | ReleaseConfig | *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:* ReleaseConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetBody | *No description.* | +| ResetDiscussionCategoryName | *No description.* | +| ResetDraft | *No description.* | +| ResetGenerateReleaseNotes | *No description.* | +| ResetId | *No description.* | +| ResetName | *No description.* | +| ResetPrerelease | *No description.* | +| ResetTargetCommitish | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetBody` + +```csharp +private void ResetBody() +``` + +##### `ResetDiscussionCategoryName` + +```csharp +private void ResetDiscussionCategoryName() +``` + +##### `ResetDraft` + +```csharp +private void ResetDraft() +``` + +##### `ResetGenerateReleaseNotes` + +```csharp +private void ResetGenerateReleaseNotes() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetName` + +```csharp +private void ResetName() +``` + +##### `ResetPrerelease` + +```csharp +private void ResetPrerelease() +``` + +##### `ResetTargetCommitish` + +```csharp +private void ResetTargetCommitish() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a Release resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +Release.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` + +```csharp +using Io.Cdktn.Providers.Github; + +Release.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +Release.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +Release.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a Release resource upon running "cdktn 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 Release to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing Release that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the Release to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| AssetsUrl | string | *No description.* | +| CreatedAt | string | *No description.* | +| Etag | string | *No description.* | +| HtmlUrl | string | *No description.* | +| NodeId | string | *No description.* | +| PublishedAt | string | *No description.* | +| ReleaseId | double | *No description.* | +| TarballUrl | string | *No description.* | +| UploadUrl | string | *No description.* | +| Url | string | *No description.* | +| ZipballUrl | string | *No description.* | +| BodyInput | string | *No description.* | +| DiscussionCategoryNameInput | string | *No description.* | +| DraftInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| GenerateReleaseNotesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| IdInput | string | *No description.* | +| NameInput | string | *No description.* | +| PrereleaseInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RepositoryInput | string | *No description.* | +| TagNameInput | string | *No description.* | +| TargetCommitishInput | string | *No description.* | +| Body | string | *No description.* | +| DiscussionCategoryName | string | *No description.* | +| Draft | bool\|Io.Cdktn.IResolvable | *No description.* | +| GenerateReleaseNotes | bool\|Io.Cdktn.IResolvable | *No description.* | +| Id | string | *No description.* | +| Name | string | *No description.* | +| Prerelease | bool\|Io.Cdktn.IResolvable | *No description.* | +| Repository | string | *No description.* | +| TagName | string | *No description.* | +| TargetCommitish | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `AssetsUrl`Required + +```csharp +public string AssetsUrl { get; } +``` + +- *Type:* string + +--- + +##### `CreatedAt`Required + +```csharp +public string CreatedAt { get; } +``` + +- *Type:* string + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `HtmlUrl`Required + +```csharp +public string HtmlUrl { get; } +``` + +- *Type:* string + +--- + +##### `NodeId`Required + +```csharp +public string NodeId { get; } +``` + +- *Type:* string + +--- + +##### `PublishedAt`Required + +```csharp +public string PublishedAt { get; } +``` + +- *Type:* string + +--- + +##### `ReleaseId`Required + +```csharp +public double ReleaseId { get; } +``` + +- *Type:* double + +--- + +##### `TarballUrl`Required + +```csharp +public string TarballUrl { get; } +``` + +- *Type:* string + +--- + +##### `UploadUrl`Required + +```csharp +public string UploadUrl { get; } +``` + +- *Type:* string + +--- + +##### `Url`Required + +```csharp +public string Url { get; } +``` + +- *Type:* string + +--- + +##### `ZipballUrl`Required + +```csharp +public string ZipballUrl { get; } +``` + +- *Type:* string + +--- + +##### `BodyInput`Optional + +```csharp +public string BodyInput { get; } +``` + +- *Type:* string + +--- + +##### `DiscussionCategoryNameInput`Optional + +```csharp +public string DiscussionCategoryNameInput { get; } +``` + +- *Type:* string + +--- + +##### `DraftInput`Optional + +```csharp +public bool|IResolvable DraftInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `GenerateReleaseNotesInput`Optional + +```csharp +public bool|IResolvable GenerateReleaseNotesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `PrereleaseInput`Optional + +```csharp +public bool|IResolvable PrereleaseInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `TagNameInput`Optional + +```csharp +public string TagNameInput { get; } +``` + +- *Type:* string + +--- + +##### `TargetCommitishInput`Optional + +```csharp +public string TargetCommitishInput { get; } +``` + +- *Type:* string + +--- + +##### `Body`Required + +```csharp +public string Body { get; } +``` + +- *Type:* string + +--- + +##### `DiscussionCategoryName`Required + +```csharp +public string DiscussionCategoryName { get; } +``` + +- *Type:* string + +--- + +##### `Draft`Required + +```csharp +public bool|IResolvable Draft { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `GenerateReleaseNotes`Required + +```csharp +public bool|IResolvable GenerateReleaseNotes { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Prerelease`Required + +```csharp +public bool|IResolvable Prerelease { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `TagName`Required + +```csharp +public string TagName { get; } +``` + +- *Type:* string + +--- + +##### `TargetCommitish`Required + +```csharp +public string TargetCommitish { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### ReleaseConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new ReleaseConfig { + 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 Repository, + string TagName, + string Body = null, + string DiscussionCategoryName = null, + bool|IResolvable Draft = null, + bool|IResolvable GenerateReleaseNotes = null, + string Id = null, + string Name = null, + bool|IResolvable Prerelease = null, + string TargetCommitish = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | The name of the repository. | +| TagName | string | The name of the tag. | +| Body | string | Text describing the contents of the tag. | +| DiscussionCategoryName | string | If specified, a discussion of the specified category is created and linked to the release. | +| Draft | bool\|Io.Cdktn.IResolvable | Set to 'false' to create a published release. | +| GenerateReleaseNotes | bool\|Io.Cdktn.IResolvable | Set to 'true' to automatically generate the name and body for this release. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#id Release#id}. | +| Name | string | The name of the release. | +| Prerelease | bool\|Io.Cdktn.IResolvable | Set to 'false' to identify the release as a full release. | +| TargetCommitish | string | The branch name or commit SHA the tag is created from. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#repository Release#repository} + +--- + +##### `TagName`Required + +```csharp +public string TagName { get; set; } +``` + +- *Type:* string + +The name of the tag. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#tag_name Release#tag_name} + +--- + +##### `Body`Optional + +```csharp +public string Body { get; set; } +``` + +- *Type:* string + +Text describing the contents of the tag. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#body Release#body} + +--- + +##### `DiscussionCategoryName`Optional + +```csharp +public string DiscussionCategoryName { get; set; } +``` + +- *Type:* string + +If specified, a discussion of the specified category is created and linked to the release. + +The value must be a category that already exists in the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#discussion_category_name Release#discussion_category_name} + +--- + +##### `Draft`Optional + +```csharp +public bool|IResolvable Draft { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Set to 'false' to create a published release. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#draft Release#draft} + +--- + +##### `GenerateReleaseNotes`Optional + +```csharp +public bool|IResolvable GenerateReleaseNotes { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Set to 'true' to automatically generate the name and body for this release. + +If 'name' is specified, the specified name will be used; otherwise, a name will be automatically generated. If 'body' is specified, the body will be pre-pended to the automatically generated notes. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#generate_release_notes Release#generate_release_notes} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#id Release#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. + +--- + +##### `Name`Optional + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +The name of the release. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#name Release#name} + +--- + +##### `Prerelease`Optional + +```csharp +public bool|IResolvable Prerelease { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Set to 'false' to identify the release as a full release. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#prerelease Release#prerelease} + +--- + +##### `TargetCommitish`Optional + +```csharp +public string TargetCommitish { get; set; } +``` + +- *Type:* string + +The branch name or commit SHA the tag is created from. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#target_commitish Release#target_commitish} + +--- + + + diff --git a/docs/release.java.md b/docs/release.java.md new file mode 100644 index 000000000..9167ebcff --- /dev/null +++ b/docs/release.java.md @@ -0,0 +1,1529 @@ +# `release` Submodule + +## Constructs + +### Release + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release github_release}. + +#### Initializers + +```java +import io.cdktn.providers.github.release.Release; + +Release.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) + .tagName(java.lang.String) +// .body(java.lang.String) +// .discussionCategoryName(java.lang.String) +// .draft(java.lang.Boolean|IResolvable) +// .generateReleaseNotes(java.lang.Boolean|IResolvable) +// .id(java.lang.String) +// .name(java.lang.String) +// .prerelease(java.lang.Boolean|IResolvable) +// .targetCommitish(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 | *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 | *No description.* | +| repository | java.lang.String | The name of the repository. | +| tagName | java.lang.String | The name of the tag. | +| body | java.lang.String | Text describing the contents of the tag. | +| discussionCategoryName | java.lang.String | If specified, a discussion of the specified category is created and linked to the release. | +| draft | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'false' to create a published release. | +| generateReleaseNotes | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to automatically generate the name and body for this release. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#id Release#id}. | +| name | java.lang.String | The name of the release. | +| prerelease | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'false' to identify the release as a full release. | +| targetCommitish | java.lang.String | The branch name or commit SHA the tag is created from. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#repository Release#repository} + +--- + +##### `tagName`Required + +- *Type:* java.lang.String + +The name of the tag. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#tag_name Release#tag_name} + +--- + +##### `body`Optional + +- *Type:* java.lang.String + +Text describing the contents of the tag. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#body Release#body} + +--- + +##### `discussionCategoryName`Optional + +- *Type:* java.lang.String + +If specified, a discussion of the specified category is created and linked to the release. + +The value must be a category that already exists in the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#discussion_category_name Release#discussion_category_name} + +--- + +##### `draft`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'false' to create a published release. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#draft Release#draft} + +--- + +##### `generateReleaseNotes`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to automatically generate the name and body for this release. + +If 'name' is specified, the specified name will be used; otherwise, a name will be automatically generated. If 'body' is specified, the body will be pre-pended to the automatically generated notes. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#generate_release_notes Release#generate_release_notes} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#id Release#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. + +--- + +##### `name`Optional + +- *Type:* java.lang.String + +The name of the release. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#name Release#name} + +--- + +##### `prerelease`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'false' to identify the release as a full release. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#prerelease Release#prerelease} + +--- + +##### `targetCommitish`Optional + +- *Type:* java.lang.String + +The branch name or commit SHA the tag is created from. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#target_commitish Release#target_commitish} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetBody | *No description.* | +| resetDiscussionCategoryName | *No description.* | +| resetDraft | *No description.* | +| resetGenerateReleaseNotes | *No description.* | +| resetId | *No description.* | +| resetName | *No description.* | +| resetPrerelease | *No description.* | +| resetTargetCommitish | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetBody` + +```java +public void resetBody() +``` + +##### `resetDiscussionCategoryName` + +```java +public void resetDiscussionCategoryName() +``` + +##### `resetDraft` + +```java +public void resetDraft() +``` + +##### `resetGenerateReleaseNotes` + +```java +public void resetGenerateReleaseNotes() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetName` + +```java +public void resetName() +``` + +##### `resetPrerelease` + +```java +public void resetPrerelease() +``` + +##### `resetTargetCommitish` + +```java +public void resetTargetCommitish() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a Release resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.release.Release; + +Release.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` + +```java +import io.cdktn.providers.github.release.Release; + +Release.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.release.Release; + +Release.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.release.Release; + +Release.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),Release.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a Release 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 Release to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing Release that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#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 Release 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| assetsUrl | java.lang.String | *No description.* | +| createdAt | java.lang.String | *No description.* | +| etag | java.lang.String | *No description.* | +| htmlUrl | java.lang.String | *No description.* | +| nodeId | java.lang.String | *No description.* | +| publishedAt | java.lang.String | *No description.* | +| releaseId | java.lang.Number | *No description.* | +| tarballUrl | java.lang.String | *No description.* | +| uploadUrl | java.lang.String | *No description.* | +| url | java.lang.String | *No description.* | +| zipballUrl | java.lang.String | *No description.* | +| bodyInput | java.lang.String | *No description.* | +| discussionCategoryNameInput | java.lang.String | *No description.* | +| draftInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| generateReleaseNotesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| idInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| prereleaseInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| tagNameInput | java.lang.String | *No description.* | +| targetCommitishInput | java.lang.String | *No description.* | +| body | java.lang.String | *No description.* | +| discussionCategoryName | java.lang.String | *No description.* | +| draft | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| generateReleaseNotes | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| prerelease | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| repository | java.lang.String | *No description.* | +| tagName | java.lang.String | *No description.* | +| targetCommitish | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `assetsUrl`Required + +```java +public java.lang.String getAssetsUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `createdAt`Required + +```java +public java.lang.String getCreatedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `htmlUrl`Required + +```java +public java.lang.String getHtmlUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `nodeId`Required + +```java +public java.lang.String getNodeId(); +``` + +- *Type:* java.lang.String + +--- + +##### `publishedAt`Required + +```java +public java.lang.String getPublishedAt(); +``` + +- *Type:* java.lang.String + +--- + +##### `releaseId`Required + +```java +public java.lang.Number getReleaseId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `tarballUrl`Required + +```java +public java.lang.String getTarballUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `uploadUrl`Required + +```java +public java.lang.String getUploadUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `zipballUrl`Required + +```java +public java.lang.String getZipballUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `bodyInput`Optional + +```java +public java.lang.String getBodyInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `discussionCategoryNameInput`Optional + +```java +public java.lang.String getDiscussionCategoryNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `draftInput`Optional + +```java +public java.lang.Boolean|IResolvable getDraftInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `generateReleaseNotesInput`Optional + +```java +public java.lang.Boolean|IResolvable getGenerateReleaseNotesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `prereleaseInput`Optional + +```java +public java.lang.Boolean|IResolvable getPrereleaseInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `tagNameInput`Optional + +```java +public java.lang.String getTagNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `targetCommitishInput`Optional + +```java +public java.lang.String getTargetCommitishInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `body`Required + +```java +public java.lang.String getBody(); +``` + +- *Type:* java.lang.String + +--- + +##### `discussionCategoryName`Required + +```java +public java.lang.String getDiscussionCategoryName(); +``` + +- *Type:* java.lang.String + +--- + +##### `draft`Required + +```java +public java.lang.Boolean|IResolvable getDraft(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `generateReleaseNotes`Required + +```java +public java.lang.Boolean|IResolvable getGenerateReleaseNotes(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `prerelease`Required + +```java +public java.lang.Boolean|IResolvable getPrerelease(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `tagName`Required + +```java +public java.lang.String getTagName(); +``` + +- *Type:* java.lang.String + +--- + +##### `targetCommitish`Required + +```java +public java.lang.String getTargetCommitish(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### ReleaseConfig + +#### Initializer + +```java +import io.cdktn.providers.github.release.ReleaseConfig; + +ReleaseConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) + .tagName(java.lang.String) +// .body(java.lang.String) +// .discussionCategoryName(java.lang.String) +// .draft(java.lang.Boolean|IResolvable) +// .generateReleaseNotes(java.lang.Boolean|IResolvable) +// .id(java.lang.String) +// .name(java.lang.String) +// .prerelease(java.lang.Boolean|IResolvable) +// .targetCommitish(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 | *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 | *No description.* | +| repository | java.lang.String | The name of the repository. | +| tagName | java.lang.String | The name of the tag. | +| body | java.lang.String | Text describing the contents of the tag. | +| discussionCategoryName | java.lang.String | If specified, a discussion of the specified category is created and linked to the release. | +| draft | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'false' to create a published release. | +| generateReleaseNotes | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to automatically generate the name and body for this release. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#id Release#id}. | +| name | java.lang.String | The name of the release. | +| prerelease | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'false' to identify the release as a full release. | +| targetCommitish | java.lang.String | The branch name or commit SHA the tag is created from. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#repository Release#repository} + +--- + +##### `tagName`Required + +```java +public java.lang.String getTagName(); +``` + +- *Type:* java.lang.String + +The name of the tag. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#tag_name Release#tag_name} + +--- + +##### `body`Optional + +```java +public java.lang.String getBody(); +``` + +- *Type:* java.lang.String + +Text describing the contents of the tag. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#body Release#body} + +--- + +##### `discussionCategoryName`Optional + +```java +public java.lang.String getDiscussionCategoryName(); +``` + +- *Type:* java.lang.String + +If specified, a discussion of the specified category is created and linked to the release. + +The value must be a category that already exists in the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#discussion_category_name Release#discussion_category_name} + +--- + +##### `draft`Optional + +```java +public java.lang.Boolean|IResolvable getDraft(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'false' to create a published release. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#draft Release#draft} + +--- + +##### `generateReleaseNotes`Optional + +```java +public java.lang.Boolean|IResolvable getGenerateReleaseNotes(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to automatically generate the name and body for this release. + +If 'name' is specified, the specified name will be used; otherwise, a name will be automatically generated. If 'body' is specified, the body will be pre-pended to the automatically generated notes. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#generate_release_notes Release#generate_release_notes} + +--- + +##### `id`Optional + +```java +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/resources/release#id Release#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. + +--- + +##### `name`Optional + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +The name of the release. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#name Release#name} + +--- + +##### `prerelease`Optional + +```java +public java.lang.Boolean|IResolvable getPrerelease(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'false' to identify the release as a full release. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#prerelease Release#prerelease} + +--- + +##### `targetCommitish`Optional + +```java +public java.lang.String getTargetCommitish(); +``` + +- *Type:* java.lang.String + +The branch name or commit SHA the tag is created from. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/release#target_commitish Release#target_commitish} + +--- + + + diff --git a/docs/repository.csharp.md b/docs/repository.csharp.md new file mode 100644 index 000000000..7943476b3 --- /dev/null +++ b/docs/repository.csharp.md @@ -0,0 +1,6379 @@ +# `repository` Submodule + +## Constructs + +### Repository + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository github_repository}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new Repository(Construct Scope, string Id, RepositoryConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | RepositoryConfig | *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:* RepositoryConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| PutPages | *No description.* | +| PutSecurityAndAnalysis | *No description.* | +| PutTemplate | *No description.* | +| ResetAllowAutoMerge | *No description.* | +| ResetAllowForking | *No description.* | +| ResetAllowMergeCommit | *No description.* | +| ResetAllowRebaseMerge | *No description.* | +| ResetAllowSquashMerge | *No description.* | +| ResetAllowUpdateBranch | *No description.* | +| ResetArchived | *No description.* | +| ResetArchiveOnDestroy | *No description.* | +| ResetAutoInit | *No description.* | +| ResetDefaultBranch | *No description.* | +| ResetDeleteBranchOnMerge | *No description.* | +| ResetDescription | *No description.* | +| ResetEtag | *No description.* | +| ResetFork | *No description.* | +| ResetGitignoreTemplate | *No description.* | +| ResetHasDiscussions | *No description.* | +| ResetHasDownloads | *No description.* | +| ResetHasIssues | *No description.* | +| ResetHasProjects | *No description.* | +| ResetHasWiki | *No description.* | +| ResetHomepageUrl | *No description.* | +| ResetId | *No description.* | +| ResetIgnoreVulnerabilityAlertsDuringRead | *No description.* | +| ResetIsTemplate | *No description.* | +| ResetLicenseTemplate | *No description.* | +| ResetMergeCommitMessage | *No description.* | +| ResetMergeCommitTitle | *No description.* | +| ResetPages | *No description.* | +| ResetPrivate | *No description.* | +| ResetSecurityAndAnalysis | *No description.* | +| ResetSourceOwner | *No description.* | +| ResetSourceRepo | *No description.* | +| ResetSquashMergeCommitMessage | *No description.* | +| ResetSquashMergeCommitTitle | *No description.* | +| ResetTemplate | *No description.* | +| ResetTopics | *No description.* | +| ResetVisibility | *No description.* | +| ResetVulnerabilityAlerts | *No description.* | +| ResetWebCommitSignoffRequired | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `PutPages` + +```csharp +private void PutPages(RepositoryPages Value) +``` + +###### `Value`Required + +- *Type:* RepositoryPages + +--- + +##### `PutSecurityAndAnalysis` + +```csharp +private void PutSecurityAndAnalysis(RepositorySecurityAndAnalysis Value) +``` + +###### `Value`Required + +- *Type:* RepositorySecurityAndAnalysis + +--- + +##### `PutTemplate` + +```csharp +private void PutTemplate(RepositoryTemplate Value) +``` + +###### `Value`Required + +- *Type:* RepositoryTemplate + +--- + +##### `ResetAllowAutoMerge` + +```csharp +private void ResetAllowAutoMerge() +``` + +##### `ResetAllowForking` + +```csharp +private void ResetAllowForking() +``` + +##### `ResetAllowMergeCommit` + +```csharp +private void ResetAllowMergeCommit() +``` + +##### `ResetAllowRebaseMerge` + +```csharp +private void ResetAllowRebaseMerge() +``` + +##### `ResetAllowSquashMerge` + +```csharp +private void ResetAllowSquashMerge() +``` + +##### `ResetAllowUpdateBranch` + +```csharp +private void ResetAllowUpdateBranch() +``` + +##### `ResetArchived` + +```csharp +private void ResetArchived() +``` + +##### `ResetArchiveOnDestroy` + +```csharp +private void ResetArchiveOnDestroy() +``` + +##### `ResetAutoInit` + +```csharp +private void ResetAutoInit() +``` + +##### `ResetDefaultBranch` + +```csharp +private void ResetDefaultBranch() +``` + +##### `ResetDeleteBranchOnMerge` + +```csharp +private void ResetDeleteBranchOnMerge() +``` + +##### `ResetDescription` + +```csharp +private void ResetDescription() +``` + +##### `ResetEtag` + +```csharp +private void ResetEtag() +``` + +##### `ResetFork` + +```csharp +private void ResetFork() +``` + +##### `ResetGitignoreTemplate` + +```csharp +private void ResetGitignoreTemplate() +``` + +##### `ResetHasDiscussions` + +```csharp +private void ResetHasDiscussions() +``` + +##### `ResetHasDownloads` + +```csharp +private void ResetHasDownloads() +``` + +##### `ResetHasIssues` + +```csharp +private void ResetHasIssues() +``` + +##### `ResetHasProjects` + +```csharp +private void ResetHasProjects() +``` + +##### `ResetHasWiki` + +```csharp +private void ResetHasWiki() +``` + +##### `ResetHomepageUrl` + +```csharp +private void ResetHomepageUrl() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetIgnoreVulnerabilityAlertsDuringRead` + +```csharp +private void ResetIgnoreVulnerabilityAlertsDuringRead() +``` + +##### `ResetIsTemplate` + +```csharp +private void ResetIsTemplate() +``` + +##### `ResetLicenseTemplate` + +```csharp +private void ResetLicenseTemplate() +``` + +##### `ResetMergeCommitMessage` + +```csharp +private void ResetMergeCommitMessage() +``` + +##### `ResetMergeCommitTitle` + +```csharp +private void ResetMergeCommitTitle() +``` + +##### `ResetPages` + +```csharp +private void ResetPages() +``` + +##### `ResetPrivate` + +```csharp +private void ResetPrivate() +``` + +##### `ResetSecurityAndAnalysis` + +```csharp +private void ResetSecurityAndAnalysis() +``` + +##### `ResetSourceOwner` + +```csharp +private void ResetSourceOwner() +``` + +##### `ResetSourceRepo` + +```csharp +private void ResetSourceRepo() +``` + +##### `ResetSquashMergeCommitMessage` + +```csharp +private void ResetSquashMergeCommitMessage() +``` + +##### `ResetSquashMergeCommitTitle` + +```csharp +private void ResetSquashMergeCommitTitle() +``` + +##### `ResetTemplate` + +```csharp +private void ResetTemplate() +``` + +##### `ResetTopics` + +```csharp +private void ResetTopics() +``` + +##### `ResetVisibility` + +```csharp +private void ResetVisibility() +``` + +##### `ResetVulnerabilityAlerts` + +```csharp +private void ResetVulnerabilityAlerts() +``` + +##### `ResetWebCommitSignoffRequired` + +```csharp +private void ResetWebCommitSignoffRequired() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a Repository resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +Repository.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` + +```csharp +using Io.Cdktn.Providers.Github; + +Repository.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +Repository.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +Repository.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a Repository resource upon running "cdktn 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 Repository to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing Repository that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the Repository to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| FullName | string | *No description.* | +| GitCloneUrl | string | *No description.* | +| HtmlUrl | string | *No description.* | +| HttpCloneUrl | string | *No description.* | +| NodeId | string | *No description.* | +| Pages | RepositoryPagesOutputReference | *No description.* | +| PrimaryLanguage | string | *No description.* | +| RepoId | double | *No description.* | +| SecurityAndAnalysis | RepositorySecurityAndAnalysisOutputReference | *No description.* | +| SshCloneUrl | string | *No description.* | +| SvnUrl | string | *No description.* | +| Template | RepositoryTemplateOutputReference | *No description.* | +| AllowAutoMergeInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| AllowForkingInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| AllowMergeCommitInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| AllowRebaseMergeInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| AllowSquashMergeInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| AllowUpdateBranchInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| ArchivedInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| ArchiveOnDestroyInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| AutoInitInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| DefaultBranchInput | string | *No description.* | +| DeleteBranchOnMergeInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| DescriptionInput | string | *No description.* | +| EtagInput | string | *No description.* | +| ForkInput | string | *No description.* | +| GitignoreTemplateInput | string | *No description.* | +| HasDiscussionsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| HasDownloadsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| HasIssuesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| HasProjectsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| HasWikiInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| HomepageUrlInput | string | *No description.* | +| IdInput | string | *No description.* | +| IgnoreVulnerabilityAlertsDuringReadInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| IsTemplateInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| LicenseTemplateInput | string | *No description.* | +| MergeCommitMessageInput | string | *No description.* | +| MergeCommitTitleInput | string | *No description.* | +| NameInput | string | *No description.* | +| PagesInput | RepositoryPages | *No description.* | +| PrivateInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| SecurityAndAnalysisInput | RepositorySecurityAndAnalysis | *No description.* | +| SourceOwnerInput | string | *No description.* | +| SourceRepoInput | string | *No description.* | +| SquashMergeCommitMessageInput | string | *No description.* | +| SquashMergeCommitTitleInput | string | *No description.* | +| TemplateInput | RepositoryTemplate | *No description.* | +| TopicsInput | string[] | *No description.* | +| VisibilityInput | string | *No description.* | +| VulnerabilityAlertsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| WebCommitSignoffRequiredInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| AllowAutoMerge | bool\|Io.Cdktn.IResolvable | *No description.* | +| AllowForking | bool\|Io.Cdktn.IResolvable | *No description.* | +| AllowMergeCommit | bool\|Io.Cdktn.IResolvable | *No description.* | +| AllowRebaseMerge | bool\|Io.Cdktn.IResolvable | *No description.* | +| AllowSquashMerge | bool\|Io.Cdktn.IResolvable | *No description.* | +| AllowUpdateBranch | bool\|Io.Cdktn.IResolvable | *No description.* | +| Archived | bool\|Io.Cdktn.IResolvable | *No description.* | +| ArchiveOnDestroy | bool\|Io.Cdktn.IResolvable | *No description.* | +| AutoInit | bool\|Io.Cdktn.IResolvable | *No description.* | +| DefaultBranch | string | *No description.* | +| DeleteBranchOnMerge | bool\|Io.Cdktn.IResolvable | *No description.* | +| Description | string | *No description.* | +| Etag | string | *No description.* | +| Fork | string | *No description.* | +| GitignoreTemplate | string | *No description.* | +| HasDiscussions | bool\|Io.Cdktn.IResolvable | *No description.* | +| HasDownloads | bool\|Io.Cdktn.IResolvable | *No description.* | +| HasIssues | bool\|Io.Cdktn.IResolvable | *No description.* | +| HasProjects | bool\|Io.Cdktn.IResolvable | *No description.* | +| HasWiki | bool\|Io.Cdktn.IResolvable | *No description.* | +| HomepageUrl | string | *No description.* | +| Id | string | *No description.* | +| IgnoreVulnerabilityAlertsDuringRead | bool\|Io.Cdktn.IResolvable | *No description.* | +| IsTemplate | bool\|Io.Cdktn.IResolvable | *No description.* | +| LicenseTemplate | string | *No description.* | +| MergeCommitMessage | string | *No description.* | +| MergeCommitTitle | string | *No description.* | +| Name | string | *No description.* | +| Private | bool\|Io.Cdktn.IResolvable | *No description.* | +| SourceOwner | string | *No description.* | +| SourceRepo | string | *No description.* | +| SquashMergeCommitMessage | string | *No description.* | +| SquashMergeCommitTitle | string | *No description.* | +| Topics | string[] | *No description.* | +| Visibility | string | *No description.* | +| VulnerabilityAlerts | bool\|Io.Cdktn.IResolvable | *No description.* | +| WebCommitSignoffRequired | bool\|Io.Cdktn.IResolvable | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `FullName`Required + +```csharp +public string FullName { get; } +``` + +- *Type:* string + +--- + +##### `GitCloneUrl`Required + +```csharp +public string GitCloneUrl { get; } +``` + +- *Type:* string + +--- + +##### `HtmlUrl`Required + +```csharp +public string HtmlUrl { get; } +``` + +- *Type:* string + +--- + +##### `HttpCloneUrl`Required + +```csharp +public string HttpCloneUrl { get; } +``` + +- *Type:* string + +--- + +##### `NodeId`Required + +```csharp +public string NodeId { get; } +``` + +- *Type:* string + +--- + +##### `Pages`Required + +```csharp +public RepositoryPagesOutputReference Pages { get; } +``` + +- *Type:* RepositoryPagesOutputReference + +--- + +##### `PrimaryLanguage`Required + +```csharp +public string PrimaryLanguage { get; } +``` + +- *Type:* string + +--- + +##### `RepoId`Required + +```csharp +public double RepoId { get; } +``` + +- *Type:* double + +--- + +##### `SecurityAndAnalysis`Required + +```csharp +public RepositorySecurityAndAnalysisOutputReference SecurityAndAnalysis { get; } +``` + +- *Type:* RepositorySecurityAndAnalysisOutputReference + +--- + +##### `SshCloneUrl`Required + +```csharp +public string SshCloneUrl { get; } +``` + +- *Type:* string + +--- + +##### `SvnUrl`Required + +```csharp +public string SvnUrl { get; } +``` + +- *Type:* string + +--- + +##### `Template`Required + +```csharp +public RepositoryTemplateOutputReference Template { get; } +``` + +- *Type:* RepositoryTemplateOutputReference + +--- + +##### `AllowAutoMergeInput`Optional + +```csharp +public bool|IResolvable AllowAutoMergeInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `AllowForkingInput`Optional + +```csharp +public bool|IResolvable AllowForkingInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `AllowMergeCommitInput`Optional + +```csharp +public bool|IResolvable AllowMergeCommitInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `AllowRebaseMergeInput`Optional + +```csharp +public bool|IResolvable AllowRebaseMergeInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `AllowSquashMergeInput`Optional + +```csharp +public bool|IResolvable AllowSquashMergeInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `AllowUpdateBranchInput`Optional + +```csharp +public bool|IResolvable AllowUpdateBranchInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ArchivedInput`Optional + +```csharp +public bool|IResolvable ArchivedInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ArchiveOnDestroyInput`Optional + +```csharp +public bool|IResolvable ArchiveOnDestroyInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `AutoInitInput`Optional + +```csharp +public bool|IResolvable AutoInitInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `DefaultBranchInput`Optional + +```csharp +public string DefaultBranchInput { get; } +``` + +- *Type:* string + +--- + +##### `DeleteBranchOnMergeInput`Optional + +```csharp +public bool|IResolvable DeleteBranchOnMergeInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `DescriptionInput`Optional + +```csharp +public string DescriptionInput { get; } +``` + +- *Type:* string + +--- + +##### `EtagInput`Optional + +```csharp +public string EtagInput { get; } +``` + +- *Type:* string + +--- + +##### `ForkInput`Optional + +```csharp +public string ForkInput { get; } +``` + +- *Type:* string + +--- + +##### `GitignoreTemplateInput`Optional + +```csharp +public string GitignoreTemplateInput { get; } +``` + +- *Type:* string + +--- + +##### `HasDiscussionsInput`Optional + +```csharp +public bool|IResolvable HasDiscussionsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `HasDownloadsInput`Optional + +```csharp +public bool|IResolvable HasDownloadsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `HasIssuesInput`Optional + +```csharp +public bool|IResolvable HasIssuesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `HasProjectsInput`Optional + +```csharp +public bool|IResolvable HasProjectsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `HasWikiInput`Optional + +```csharp +public bool|IResolvable HasWikiInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `HomepageUrlInput`Optional + +```csharp +public string HomepageUrlInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `IgnoreVulnerabilityAlertsDuringReadInput`Optional + +```csharp +public bool|IResolvable IgnoreVulnerabilityAlertsDuringReadInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `IsTemplateInput`Optional + +```csharp +public bool|IResolvable IsTemplateInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `LicenseTemplateInput`Optional + +```csharp +public string LicenseTemplateInput { get; } +``` + +- *Type:* string + +--- + +##### `MergeCommitMessageInput`Optional + +```csharp +public string MergeCommitMessageInput { get; } +``` + +- *Type:* string + +--- + +##### `MergeCommitTitleInput`Optional + +```csharp +public string MergeCommitTitleInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `PagesInput`Optional + +```csharp +public RepositoryPages PagesInput { get; } +``` + +- *Type:* RepositoryPages + +--- + +##### `PrivateInput`Optional + +```csharp +public bool|IResolvable PrivateInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `SecurityAndAnalysisInput`Optional + +```csharp +public RepositorySecurityAndAnalysis SecurityAndAnalysisInput { get; } +``` + +- *Type:* RepositorySecurityAndAnalysis + +--- + +##### `SourceOwnerInput`Optional + +```csharp +public string SourceOwnerInput { get; } +``` + +- *Type:* string + +--- + +##### `SourceRepoInput`Optional + +```csharp +public string SourceRepoInput { get; } +``` + +- *Type:* string + +--- + +##### `SquashMergeCommitMessageInput`Optional + +```csharp +public string SquashMergeCommitMessageInput { get; } +``` + +- *Type:* string + +--- + +##### `SquashMergeCommitTitleInput`Optional + +```csharp +public string SquashMergeCommitTitleInput { get; } +``` + +- *Type:* string + +--- + +##### `TemplateInput`Optional + +```csharp +public RepositoryTemplate TemplateInput { get; } +``` + +- *Type:* RepositoryTemplate + +--- + +##### `TopicsInput`Optional + +```csharp +public string[] TopicsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `VisibilityInput`Optional + +```csharp +public string VisibilityInput { get; } +``` + +- *Type:* string + +--- + +##### `VulnerabilityAlertsInput`Optional + +```csharp +public bool|IResolvable VulnerabilityAlertsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `WebCommitSignoffRequiredInput`Optional + +```csharp +public bool|IResolvable WebCommitSignoffRequiredInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `AllowAutoMerge`Required + +```csharp +public bool|IResolvable AllowAutoMerge { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `AllowForking`Required + +```csharp +public bool|IResolvable AllowForking { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `AllowMergeCommit`Required + +```csharp +public bool|IResolvable AllowMergeCommit { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `AllowRebaseMerge`Required + +```csharp +public bool|IResolvable AllowRebaseMerge { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `AllowSquashMerge`Required + +```csharp +public bool|IResolvable AllowSquashMerge { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `AllowUpdateBranch`Required + +```csharp +public bool|IResolvable AllowUpdateBranch { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Archived`Required + +```csharp +public bool|IResolvable Archived { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ArchiveOnDestroy`Required + +```csharp +public bool|IResolvable ArchiveOnDestroy { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `AutoInit`Required + +```csharp +public bool|IResolvable AutoInit { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `DefaultBranch`Required + +```csharp +public string DefaultBranch { get; } +``` + +- *Type:* string + +--- + +##### `DeleteBranchOnMerge`Required + +```csharp +public bool|IResolvable DeleteBranchOnMerge { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `Fork`Required + +```csharp +public string Fork { get; } +``` + +- *Type:* string + +--- + +##### `GitignoreTemplate`Required + +```csharp +public string GitignoreTemplate { get; } +``` + +- *Type:* string + +--- + +##### `HasDiscussions`Required + +```csharp +public bool|IResolvable HasDiscussions { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `HasDownloads`Required + +```csharp +public bool|IResolvable HasDownloads { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `HasIssues`Required + +```csharp +public bool|IResolvable HasIssues { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `HasProjects`Required + +```csharp +public bool|IResolvable HasProjects { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `HasWiki`Required + +```csharp +public bool|IResolvable HasWiki { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `HomepageUrl`Required + +```csharp +public string HomepageUrl { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `IgnoreVulnerabilityAlertsDuringRead`Required + +```csharp +public bool|IResolvable IgnoreVulnerabilityAlertsDuringRead { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `IsTemplate`Required + +```csharp +public bool|IResolvable IsTemplate { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `LicenseTemplate`Required + +```csharp +public string LicenseTemplate { get; } +``` + +- *Type:* string + +--- + +##### `MergeCommitMessage`Required + +```csharp +public string MergeCommitMessage { get; } +``` + +- *Type:* string + +--- + +##### `MergeCommitTitle`Required + +```csharp +public string MergeCommitTitle { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Private`Required + +```csharp +public bool|IResolvable Private { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `SourceOwner`Required + +```csharp +public string SourceOwner { get; } +``` + +- *Type:* string + +--- + +##### `SourceRepo`Required + +```csharp +public string SourceRepo { get; } +``` + +- *Type:* string + +--- + +##### `SquashMergeCommitMessage`Required + +```csharp +public string SquashMergeCommitMessage { get; } +``` + +- *Type:* string + +--- + +##### `SquashMergeCommitTitle`Required + +```csharp +public string SquashMergeCommitTitle { get; } +``` + +- *Type:* string + +--- + +##### `Topics`Required + +```csharp +public string[] Topics { get; } +``` + +- *Type:* string[] + +--- + +##### `Visibility`Required + +```csharp +public string Visibility { get; } +``` + +- *Type:* string + +--- + +##### `VulnerabilityAlerts`Required + +```csharp +public bool|IResolvable VulnerabilityAlerts { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `WebCommitSignoffRequired`Required + +```csharp +public bool|IResolvable WebCommitSignoffRequired { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### RepositoryConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryConfig { + 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 Name, + bool|IResolvable AllowAutoMerge = null, + bool|IResolvable AllowForking = null, + bool|IResolvable AllowMergeCommit = null, + bool|IResolvable AllowRebaseMerge = null, + bool|IResolvable AllowSquashMerge = null, + bool|IResolvable AllowUpdateBranch = null, + bool|IResolvable Archived = null, + bool|IResolvable ArchiveOnDestroy = null, + bool|IResolvable AutoInit = null, + string DefaultBranch = null, + bool|IResolvable DeleteBranchOnMerge = null, + string Description = null, + string Etag = null, + string Fork = null, + string GitignoreTemplate = null, + bool|IResolvable HasDiscussions = null, + bool|IResolvable HasDownloads = null, + bool|IResolvable HasIssues = null, + bool|IResolvable HasProjects = null, + bool|IResolvable HasWiki = null, + string HomepageUrl = null, + string Id = null, + bool|IResolvable IgnoreVulnerabilityAlertsDuringRead = null, + bool|IResolvable IsTemplate = null, + string LicenseTemplate = null, + string MergeCommitMessage = null, + string MergeCommitTitle = null, + RepositoryPages Pages = null, + bool|IResolvable Private = null, + RepositorySecurityAndAnalysis SecurityAndAnalysis = null, + string SourceOwner = null, + string SourceRepo = null, + string SquashMergeCommitMessage = null, + string SquashMergeCommitTitle = null, + RepositoryTemplate Template = null, + string[] Topics = null, + string Visibility = null, + bool|IResolvable VulnerabilityAlerts = null, + bool|IResolvable WebCommitSignoffRequired = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Name | string | The name of the repository. | +| AllowAutoMerge | bool\|Io.Cdktn.IResolvable | Set to 'true' to allow auto-merging pull requests on the repository. | +| AllowForking | bool\|Io.Cdktn.IResolvable | Set to 'true' to allow private forking on the repository; | +| AllowMergeCommit | bool\|Io.Cdktn.IResolvable | Set to 'false' to disable merge commits on the repository. | +| AllowRebaseMerge | bool\|Io.Cdktn.IResolvable | Set to 'false' to disable rebase merges on the repository. | +| AllowSquashMerge | bool\|Io.Cdktn.IResolvable | Set to 'false' to disable squash merges on the repository. | +| AllowUpdateBranch | bool\|Io.Cdktn.IResolvable | Set to 'true' to always suggest updating pull request branches. | +| Archived | bool\|Io.Cdktn.IResolvable | Specifies if the repository should be archived. Defaults to 'false'. NOTE Currently, the API does not support unarchiving. | +| ArchiveOnDestroy | bool\|Io.Cdktn.IResolvable | Set to 'true' to archive the repository instead of deleting on destroy. | +| AutoInit | bool\|Io.Cdktn.IResolvable | Set to 'true' to produce an initial commit in the repository. | +| DefaultBranch | string | Can only be set after initial repository creation, and only if the target branch exists. | +| DeleteBranchOnMerge | bool\|Io.Cdktn.IResolvable | Automatically delete head branch after a pull request is merged. Defaults to 'false'. | +| Description | string | A description of the repository. | +| Etag | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#etag Repository#etag}. | +| Fork | string | Set to 'true' to fork an existing repository. | +| GitignoreTemplate | string | Use the name of the template without the extension. For example, 'Haskell'. | +| HasDiscussions | bool\|Io.Cdktn.IResolvable | Set to 'true' to enable GitHub Discussions on the repository. Defaults to 'false'. | +| HasDownloads | bool\|Io.Cdktn.IResolvable | Set to 'true' to enable the (deprecated) downloads features on the repository. | +| HasIssues | bool\|Io.Cdktn.IResolvable | Set to 'true' to enable the GitHub Issues features on the repository. | +| HasProjects | bool\|Io.Cdktn.IResolvable | Set to 'true' to enable the GitHub Projects features on the repository. | +| HasWiki | bool\|Io.Cdktn.IResolvable | Set to 'true' to enable the GitHub Wiki features on the repository. | +| HomepageUrl | string | URL of a page describing the project. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#id Repository#id}. | +| IgnoreVulnerabilityAlertsDuringRead | bool\|Io.Cdktn.IResolvable | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#ignore_vulnerability_alerts_during_read Repository#ignore_vulnerability_alerts_during_read}. | +| IsTemplate | bool\|Io.Cdktn.IResolvable | Set to 'true' to tell GitHub that this is a template repository. | +| LicenseTemplate | string | Use the name of the template without the extension. For example, 'mit' or 'mpl-2.0'. | +| MergeCommitMessage | string | Can be 'PR_BODY', 'PR_TITLE', or 'BLANK' for a default merge commit message. | +| MergeCommitTitle | string | Can be 'PR_TITLE' or 'MERGE_MESSAGE' for a default merge commit title. | +| Pages | RepositoryPages | pages block. | +| Private | bool\|Io.Cdktn.IResolvable | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#private Repository#private}. | +| SecurityAndAnalysis | RepositorySecurityAndAnalysis | security_and_analysis block. | +| SourceOwner | string | The owner of the source repository to fork from. | +| SourceRepo | string | The name of the source repository to fork from. | +| SquashMergeCommitMessage | string | Can be 'PR_BODY', 'COMMIT_MESSAGES', or 'BLANK' for a default squash merge commit message. | +| SquashMergeCommitTitle | string | Can be 'PR_TITLE' or 'COMMIT_OR_PR_TITLE' for a default squash merge commit title. | +| Template | RepositoryTemplate | template block. | +| Topics | string[] | The list of topics of the repository. | +| Visibility | string | Can be 'public' or 'private'. | +| VulnerabilityAlerts | bool\|Io.Cdktn.IResolvable | Set to 'true' to enable security alerts for vulnerable dependencies. | +| WebCommitSignoffRequired | bool\|Io.Cdktn.IResolvable | Require contributors to sign off on web-based commits. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Name`Required + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +The name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#name Repository#name} + +--- + +##### `AllowAutoMerge`Optional + +```csharp +public bool|IResolvable AllowAutoMerge { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Set to 'true' to allow auto-merging pull requests on the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#allow_auto_merge Repository#allow_auto_merge} + +--- + +##### `AllowForking`Optional + +```csharp +public bool|IResolvable AllowForking { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Set to 'true' to allow private forking on the repository; + +this is only relevant if the repository is owned by an organization and is private or internal. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#allow_forking Repository#allow_forking} + +--- + +##### `AllowMergeCommit`Optional + +```csharp +public bool|IResolvable AllowMergeCommit { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Set to 'false' to disable merge commits on the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#allow_merge_commit Repository#allow_merge_commit} + +--- + +##### `AllowRebaseMerge`Optional + +```csharp +public bool|IResolvable AllowRebaseMerge { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Set to 'false' to disable rebase merges on the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#allow_rebase_merge Repository#allow_rebase_merge} + +--- + +##### `AllowSquashMerge`Optional + +```csharp +public bool|IResolvable AllowSquashMerge { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Set to 'false' to disable squash merges on the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#allow_squash_merge Repository#allow_squash_merge} + +--- + +##### `AllowUpdateBranch`Optional + +```csharp +public bool|IResolvable AllowUpdateBranch { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Set to 'true' to always suggest updating pull request branches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#allow_update_branch Repository#allow_update_branch} + +--- + +##### `Archived`Optional + +```csharp +public bool|IResolvable Archived { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Specifies if the repository should be archived. Defaults to 'false'. NOTE Currently, the API does not support unarchiving. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#archived Repository#archived} + +--- + +##### `ArchiveOnDestroy`Optional + +```csharp +public bool|IResolvable ArchiveOnDestroy { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Set to 'true' to archive the repository instead of deleting on destroy. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#archive_on_destroy Repository#archive_on_destroy} + +--- + +##### `AutoInit`Optional + +```csharp +public bool|IResolvable AutoInit { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Set to 'true' to produce an initial commit in the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#auto_init Repository#auto_init} + +--- + +##### `DefaultBranch`Optional + +```csharp +public string DefaultBranch { get; set; } +``` + +- *Type:* string + +Can only be set after initial repository creation, and only if the target branch exists. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#default_branch Repository#default_branch} + +--- + +##### `DeleteBranchOnMerge`Optional + +```csharp +public bool|IResolvable DeleteBranchOnMerge { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Automatically delete head branch after a pull request is merged. Defaults to 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#delete_branch_on_merge Repository#delete_branch_on_merge} + +--- + +##### `Description`Optional + +```csharp +public string Description { get; set; } +``` + +- *Type:* string + +A description of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#description Repository#description} + +--- + +##### `Etag`Optional + +```csharp +public string Etag { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#etag Repository#etag}. + +--- + +##### `Fork`Optional + +```csharp +public string Fork { get; set; } +``` + +- *Type:* string + +Set to 'true' to fork an existing repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#fork Repository#fork} + +--- + +##### `GitignoreTemplate`Optional + +```csharp +public string GitignoreTemplate { get; set; } +``` + +- *Type:* string + +Use the name of the template without the extension. For example, 'Haskell'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#gitignore_template Repository#gitignore_template} + +--- + +##### `HasDiscussions`Optional + +```csharp +public bool|IResolvable HasDiscussions { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Set to 'true' to enable GitHub Discussions on the repository. Defaults to 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#has_discussions Repository#has_discussions} + +--- + +##### `HasDownloads`Optional + +```csharp +public bool|IResolvable HasDownloads { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Set to 'true' to enable the (deprecated) downloads features on the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#has_downloads Repository#has_downloads} + +--- + +##### `HasIssues`Optional + +```csharp +public bool|IResolvable HasIssues { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Set to 'true' to enable the GitHub Issues features on the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#has_issues Repository#has_issues} + +--- + +##### `HasProjects`Optional + +```csharp +public bool|IResolvable HasProjects { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Set to 'true' to enable the GitHub Projects features on the repository. + +Per the GitHub documentation when in an organization that has disabled repository projects it will default to 'false' and will otherwise default to 'true'. If you specify 'true' when it has been disabled it will return an error. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#has_projects Repository#has_projects} + +--- + +##### `HasWiki`Optional + +```csharp +public bool|IResolvable HasWiki { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Set to 'true' to enable the GitHub Wiki features on the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#has_wiki Repository#has_wiki} + +--- + +##### `HomepageUrl`Optional + +```csharp +public string HomepageUrl { get; set; } +``` + +- *Type:* string + +URL of a page describing the project. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#homepage_url Repository#homepage_url} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#id Repository#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. + +--- + +##### `IgnoreVulnerabilityAlertsDuringRead`Optional + +```csharp +public bool|IResolvable IgnoreVulnerabilityAlertsDuringRead { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#ignore_vulnerability_alerts_during_read Repository#ignore_vulnerability_alerts_during_read}. + +--- + +##### `IsTemplate`Optional + +```csharp +public bool|IResolvable IsTemplate { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Set to 'true' to tell GitHub that this is a template repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#is_template Repository#is_template} + +--- + +##### `LicenseTemplate`Optional + +```csharp +public string LicenseTemplate { get; set; } +``` + +- *Type:* string + +Use the name of the template without the extension. For example, 'mit' or 'mpl-2.0'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#license_template Repository#license_template} + +--- + +##### `MergeCommitMessage`Optional + +```csharp +public string MergeCommitMessage { get; set; } +``` + +- *Type:* string + +Can be 'PR_BODY', 'PR_TITLE', or 'BLANK' for a default merge commit message. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#merge_commit_message Repository#merge_commit_message} + +--- + +##### `MergeCommitTitle`Optional + +```csharp +public string MergeCommitTitle { get; set; } +``` + +- *Type:* string + +Can be 'PR_TITLE' or 'MERGE_MESSAGE' for a default merge commit title. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#merge_commit_title Repository#merge_commit_title} + +--- + +##### `Pages`Optional + +```csharp +public RepositoryPages Pages { get; set; } +``` + +- *Type:* RepositoryPages + +pages block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#pages Repository#pages} + +--- + +##### `Private`Optional + +```csharp +public bool|IResolvable Private { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#private Repository#private}. + +--- + +##### `SecurityAndAnalysis`Optional + +```csharp +public RepositorySecurityAndAnalysis SecurityAndAnalysis { get; set; } +``` + +- *Type:* RepositorySecurityAndAnalysis + +security_and_analysis block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#security_and_analysis Repository#security_and_analysis} + +--- + +##### `SourceOwner`Optional + +```csharp +public string SourceOwner { get; set; } +``` + +- *Type:* string + +The owner of the source repository to fork from. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#source_owner Repository#source_owner} + +--- + +##### `SourceRepo`Optional + +```csharp +public string SourceRepo { get; set; } +``` + +- *Type:* string + +The name of the source repository to fork from. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#source_repo Repository#source_repo} + +--- + +##### `SquashMergeCommitMessage`Optional + +```csharp +public string SquashMergeCommitMessage { get; set; } +``` + +- *Type:* string + +Can be 'PR_BODY', 'COMMIT_MESSAGES', or 'BLANK' for a default squash merge commit message. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#squash_merge_commit_message Repository#squash_merge_commit_message} + +--- + +##### `SquashMergeCommitTitle`Optional + +```csharp +public string SquashMergeCommitTitle { get; set; } +``` + +- *Type:* string + +Can be 'PR_TITLE' or 'COMMIT_OR_PR_TITLE' for a default squash merge commit title. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#squash_merge_commit_title Repository#squash_merge_commit_title} + +--- + +##### `Template`Optional + +```csharp +public RepositoryTemplate Template { get; set; } +``` + +- *Type:* RepositoryTemplate + +template block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#template Repository#template} + +--- + +##### `Topics`Optional + +```csharp +public string[] Topics { get; set; } +``` + +- *Type:* string[] + +The list of topics of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#topics Repository#topics} + +--- + +##### `Visibility`Optional + +```csharp +public string Visibility { get; set; } +``` + +- *Type:* string + +Can be 'public' or 'private'. + +If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be 'internal'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#visibility Repository#visibility} + +--- + +##### `VulnerabilityAlerts`Optional + +```csharp +public bool|IResolvable VulnerabilityAlerts { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Set to 'true' to enable security alerts for vulnerable dependencies. + +Enabling requires alerts to be enabled on the owner level. (Note for importing: GitHub enables the alerts on all repos by default). Note that vulnerability alerts have not been successfully tested on any GitHub Enterprise instance and may be unavailable in those settings. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#vulnerability_alerts Repository#vulnerability_alerts} + +--- + +##### `WebCommitSignoffRequired`Optional + +```csharp +public bool|IResolvable WebCommitSignoffRequired { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Require contributors to sign off on web-based commits. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#web_commit_signoff_required Repository#web_commit_signoff_required} + +--- + +### RepositoryPages + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryPages { + string BuildType = null, + string Cname = null, + RepositoryPagesSource Source = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| BuildType | string | The type the page should be sourced. | +| Cname | string | The custom domain for the repository. This can only be set after the repository has been created. | +| Source | RepositoryPagesSource | source block. | + +--- + +##### `BuildType`Optional + +```csharp +public string BuildType { get; set; } +``` + +- *Type:* string + +The type the page should be sourced. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#build_type Repository#build_type} + +--- + +##### `Cname`Optional + +```csharp +public string Cname { get; set; } +``` + +- *Type:* string + +The custom domain for the repository. This can only be set after the repository has been created. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#cname Repository#cname} + +--- + +##### `Source`Optional + +```csharp +public RepositoryPagesSource Source { get; set; } +``` + +- *Type:* RepositoryPagesSource + +source block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#source Repository#source} + +--- + +### RepositoryPagesSource + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryPagesSource { + string Branch, + string Path = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Branch | string | The repository branch used to publish the site's source files. (i.e. 'main' or 'gh-pages'). | +| Path | string | The repository directory from which the site publishes (Default: '/'). | + +--- + +##### `Branch`Required + +```csharp +public string Branch { get; set; } +``` + +- *Type:* string + +The repository branch used to publish the site's source files. (i.e. 'main' or 'gh-pages'). + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#branch Repository#branch} + +--- + +##### `Path`Optional + +```csharp +public string Path { get; set; } +``` + +- *Type:* string + +The repository directory from which the site publishes (Default: '/'). + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#path Repository#path} + +--- + +### RepositorySecurityAndAnalysis + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositorySecurityAndAnalysis { + RepositorySecurityAndAnalysisAdvancedSecurity AdvancedSecurity = null, + RepositorySecurityAndAnalysisCodeSecurity CodeSecurity = null, + RepositorySecurityAndAnalysisSecretScanning SecretScanning = null, + RepositorySecurityAndAnalysisSecretScanningAiDetection SecretScanningAiDetection = null, + RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns SecretScanningNonProviderPatterns = null, + RepositorySecurityAndAnalysisSecretScanningPushProtection SecretScanningPushProtection = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| AdvancedSecurity | RepositorySecurityAndAnalysisAdvancedSecurity | advanced_security block. | +| CodeSecurity | RepositorySecurityAndAnalysisCodeSecurity | code_security block. | +| SecretScanning | RepositorySecurityAndAnalysisSecretScanning | secret_scanning block. | +| SecretScanningAiDetection | RepositorySecurityAndAnalysisSecretScanningAiDetection | secret_scanning_ai_detection block. | +| SecretScanningNonProviderPatterns | RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns | secret_scanning_non_provider_patterns block. | +| SecretScanningPushProtection | RepositorySecurityAndAnalysisSecretScanningPushProtection | secret_scanning_push_protection block. | + +--- + +##### `AdvancedSecurity`Optional + +```csharp +public RepositorySecurityAndAnalysisAdvancedSecurity AdvancedSecurity { get; set; } +``` + +- *Type:* RepositorySecurityAndAnalysisAdvancedSecurity + +advanced_security block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#advanced_security Repository#advanced_security} + +--- + +##### `CodeSecurity`Optional + +```csharp +public RepositorySecurityAndAnalysisCodeSecurity CodeSecurity { get; set; } +``` + +- *Type:* RepositorySecurityAndAnalysisCodeSecurity + +code_security block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#code_security Repository#code_security} + +--- + +##### `SecretScanning`Optional + +```csharp +public RepositorySecurityAndAnalysisSecretScanning SecretScanning { get; set; } +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanning + +secret_scanning block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#secret_scanning Repository#secret_scanning} + +--- + +##### `SecretScanningAiDetection`Optional + +```csharp +public RepositorySecurityAndAnalysisSecretScanningAiDetection SecretScanningAiDetection { get; set; } +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningAiDetection + +secret_scanning_ai_detection block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#secret_scanning_ai_detection Repository#secret_scanning_ai_detection} + +--- + +##### `SecretScanningNonProviderPatterns`Optional + +```csharp +public RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns SecretScanningNonProviderPatterns { get; set; } +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns + +secret_scanning_non_provider_patterns block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#secret_scanning_non_provider_patterns Repository#secret_scanning_non_provider_patterns} + +--- + +##### `SecretScanningPushProtection`Optional + +```csharp +public RepositorySecurityAndAnalysisSecretScanningPushProtection SecretScanningPushProtection { get; set; } +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningPushProtection + +secret_scanning_push_protection block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#secret_scanning_push_protection Repository#secret_scanning_push_protection} + +--- + +### RepositorySecurityAndAnalysisAdvancedSecurity + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositorySecurityAndAnalysisAdvancedSecurity { + string Status +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Status | string | Set to 'enabled' to enable advanced security features on the repository. | + +--- + +##### `Status`Required + +```csharp +public string Status { get; set; } +``` + +- *Type:* string + +Set to 'enabled' to enable advanced security features on the repository. + +Can be 'enabled' or 'disabled', This value being present when split licensing is enabled will error out. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#status Repository#status} + +--- + +### RepositorySecurityAndAnalysisCodeSecurity + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositorySecurityAndAnalysisCodeSecurity { + string Status +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Status | string | Set to 'enabled' to enable code security on the repository. | + +--- + +##### `Status`Required + +```csharp +public string Status { get; set; } +``` + +- *Type:* string + +Set to 'enabled' to enable code security on the repository. + +Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#status Repository#status} + +--- + +### RepositorySecurityAndAnalysisSecretScanning + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositorySecurityAndAnalysisSecretScanning { + string Status +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Status | string | Set to 'enabled' to enable secret scanning on the repository. | + +--- + +##### `Status`Required + +```csharp +public string Status { get; set; } +``` + +- *Type:* string + +Set to 'enabled' to enable secret scanning on the repository. + +Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#status Repository#status} + +--- + +### RepositorySecurityAndAnalysisSecretScanningAiDetection + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositorySecurityAndAnalysisSecretScanningAiDetection { + string Status +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Status | string | Set to 'enabled' to enable secret scanning AI detection on the repository. | + +--- + +##### `Status`Required + +```csharp +public string Status { get; set; } +``` + +- *Type:* string + +Set to 'enabled' to enable secret scanning AI detection on the repository. + +Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#status Repository#status} + +--- + +### RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns { + string Status +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Status | string | Set to 'enabled' to enable secret scanning non-provider patterns on the repository. | + +--- + +##### `Status`Required + +```csharp +public string Status { get; set; } +``` + +- *Type:* string + +Set to 'enabled' to enable secret scanning non-provider patterns on the repository. + +Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#status Repository#status} + +--- + +### RepositorySecurityAndAnalysisSecretScanningPushProtection + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositorySecurityAndAnalysisSecretScanningPushProtection { + string Status +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Status | string | Set to 'enabled' to enable secret scanning push protection on the repository. | + +--- + +##### `Status`Required + +```csharp +public string Status { get; set; } +``` + +- *Type:* string + +Set to 'enabled' to enable secret scanning push protection on the repository. + +Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#status Repository#status} + +--- + +### RepositoryTemplate + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryTemplate { + string Owner, + string Repository, + bool|IResolvable IncludeAllBranches = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Owner | string | The GitHub organization or user the template repository is owned by. | +| Repository | string | The name of the template repository. | +| IncludeAllBranches | bool\|Io.Cdktn.IResolvable | Whether the new repository should include all the branches from the template repository (defaults to 'false', which includes only the default branch from the template). | + +--- + +##### `Owner`Required + +```csharp +public string Owner { get; set; } +``` + +- *Type:* string + +The GitHub organization or user the template repository is owned by. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#owner Repository#owner} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The name of the template repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#repository Repository#repository} + +--- + +##### `IncludeAllBranches`Optional + +```csharp +public bool|IResolvable IncludeAllBranches { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether the new repository should include all the branches from the template repository (defaults to 'false', which includes only the default branch from the template). + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#include_all_branches Repository#include_all_branches} + +--- + +## Classes + +### RepositoryPagesOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryPagesOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| PutSource | *No description.* | +| ResetBuildType | *No description.* | +| ResetCname | *No description.* | +| ResetSource | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `PutSource` + +```csharp +private void PutSource(RepositoryPagesSource Value) +``` + +###### `Value`Required + +- *Type:* RepositoryPagesSource + +--- + +##### `ResetBuildType` + +```csharp +private void ResetBuildType() +``` + +##### `ResetCname` + +```csharp +private void ResetCname() +``` + +##### `ResetSource` + +```csharp +private void ResetSource() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Custom404 | Io.Cdktn.IResolvable | *No description.* | +| HtmlUrl | string | *No description.* | +| Source | RepositoryPagesSourceOutputReference | *No description.* | +| Status | string | *No description.* | +| Url | string | *No description.* | +| BuildTypeInput | string | *No description.* | +| CnameInput | string | *No description.* | +| SourceInput | RepositoryPagesSource | *No description.* | +| BuildType | string | *No description.* | +| Cname | string | *No description.* | +| InternalValue | RepositoryPages | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Custom404`Required + +```csharp +public IResolvable Custom404 { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `HtmlUrl`Required + +```csharp +public string HtmlUrl { get; } +``` + +- *Type:* string + +--- + +##### `Source`Required + +```csharp +public RepositoryPagesSourceOutputReference Source { get; } +``` + +- *Type:* RepositoryPagesSourceOutputReference + +--- + +##### `Status`Required + +```csharp +public string Status { get; } +``` + +- *Type:* string + +--- + +##### `Url`Required + +```csharp +public string Url { get; } +``` + +- *Type:* string + +--- + +##### `BuildTypeInput`Optional + +```csharp +public string BuildTypeInput { get; } +``` + +- *Type:* string + +--- + +##### `CnameInput`Optional + +```csharp +public string CnameInput { get; } +``` + +- *Type:* string + +--- + +##### `SourceInput`Optional + +```csharp +public RepositoryPagesSource SourceInput { get; } +``` + +- *Type:* RepositoryPagesSource + +--- + +##### `BuildType`Required + +```csharp +public string BuildType { get; } +``` + +- *Type:* string + +--- + +##### `Cname`Required + +```csharp +public string Cname { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryPages InternalValue { get; } +``` + +- *Type:* RepositoryPages + +--- + + +### RepositoryPagesSourceOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryPagesSourceOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetPath | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetPath` + +```csharp +private void ResetPath() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| BranchInput | string | *No description.* | +| PathInput | string | *No description.* | +| Branch | string | *No description.* | +| Path | string | *No description.* | +| InternalValue | RepositoryPagesSource | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `BranchInput`Optional + +```csharp +public string BranchInput { get; } +``` + +- *Type:* string + +--- + +##### `PathInput`Optional + +```csharp +public string PathInput { get; } +``` + +- *Type:* string + +--- + +##### `Branch`Required + +```csharp +public string Branch { get; } +``` + +- *Type:* string + +--- + +##### `Path`Required + +```csharp +public string Path { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryPagesSource InternalValue { get; } +``` + +- *Type:* RepositoryPagesSource + +--- + + +### RepositorySecurityAndAnalysisAdvancedSecurityOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositorySecurityAndAnalysisAdvancedSecurityOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| StatusInput | string | *No description.* | +| Status | string | *No description.* | +| InternalValue | RepositorySecurityAndAnalysisAdvancedSecurity | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `StatusInput`Optional + +```csharp +public string StatusInput { get; } +``` + +- *Type:* string + +--- + +##### `Status`Required + +```csharp +public string Status { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public RepositorySecurityAndAnalysisAdvancedSecurity InternalValue { get; } +``` + +- *Type:* RepositorySecurityAndAnalysisAdvancedSecurity + +--- + + +### RepositorySecurityAndAnalysisCodeSecurityOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositorySecurityAndAnalysisCodeSecurityOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| StatusInput | string | *No description.* | +| Status | string | *No description.* | +| InternalValue | RepositorySecurityAndAnalysisCodeSecurity | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `StatusInput`Optional + +```csharp +public string StatusInput { get; } +``` + +- *Type:* string + +--- + +##### `Status`Required + +```csharp +public string Status { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public RepositorySecurityAndAnalysisCodeSecurity InternalValue { get; } +``` + +- *Type:* RepositorySecurityAndAnalysisCodeSecurity + +--- + + +### RepositorySecurityAndAnalysisOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositorySecurityAndAnalysisOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| PutAdvancedSecurity | *No description.* | +| PutCodeSecurity | *No description.* | +| PutSecretScanning | *No description.* | +| PutSecretScanningAiDetection | *No description.* | +| PutSecretScanningNonProviderPatterns | *No description.* | +| PutSecretScanningPushProtection | *No description.* | +| ResetAdvancedSecurity | *No description.* | +| ResetCodeSecurity | *No description.* | +| ResetSecretScanning | *No description.* | +| ResetSecretScanningAiDetection | *No description.* | +| ResetSecretScanningNonProviderPatterns | *No description.* | +| ResetSecretScanningPushProtection | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `PutAdvancedSecurity` + +```csharp +private void PutAdvancedSecurity(RepositorySecurityAndAnalysisAdvancedSecurity Value) +``` + +###### `Value`Required + +- *Type:* RepositorySecurityAndAnalysisAdvancedSecurity + +--- + +##### `PutCodeSecurity` + +```csharp +private void PutCodeSecurity(RepositorySecurityAndAnalysisCodeSecurity Value) +``` + +###### `Value`Required + +- *Type:* RepositorySecurityAndAnalysisCodeSecurity + +--- + +##### `PutSecretScanning` + +```csharp +private void PutSecretScanning(RepositorySecurityAndAnalysisSecretScanning Value) +``` + +###### `Value`Required + +- *Type:* RepositorySecurityAndAnalysisSecretScanning + +--- + +##### `PutSecretScanningAiDetection` + +```csharp +private void PutSecretScanningAiDetection(RepositorySecurityAndAnalysisSecretScanningAiDetection Value) +``` + +###### `Value`Required + +- *Type:* RepositorySecurityAndAnalysisSecretScanningAiDetection + +--- + +##### `PutSecretScanningNonProviderPatterns` + +```csharp +private void PutSecretScanningNonProviderPatterns(RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns Value) +``` + +###### `Value`Required + +- *Type:* RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns + +--- + +##### `PutSecretScanningPushProtection` + +```csharp +private void PutSecretScanningPushProtection(RepositorySecurityAndAnalysisSecretScanningPushProtection Value) +``` + +###### `Value`Required + +- *Type:* RepositorySecurityAndAnalysisSecretScanningPushProtection + +--- + +##### `ResetAdvancedSecurity` + +```csharp +private void ResetAdvancedSecurity() +``` + +##### `ResetCodeSecurity` + +```csharp +private void ResetCodeSecurity() +``` + +##### `ResetSecretScanning` + +```csharp +private void ResetSecretScanning() +``` + +##### `ResetSecretScanningAiDetection` + +```csharp +private void ResetSecretScanningAiDetection() +``` + +##### `ResetSecretScanningNonProviderPatterns` + +```csharp +private void ResetSecretScanningNonProviderPatterns() +``` + +##### `ResetSecretScanningPushProtection` + +```csharp +private void ResetSecretScanningPushProtection() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| AdvancedSecurity | RepositorySecurityAndAnalysisAdvancedSecurityOutputReference | *No description.* | +| CodeSecurity | RepositorySecurityAndAnalysisCodeSecurityOutputReference | *No description.* | +| SecretScanning | RepositorySecurityAndAnalysisSecretScanningOutputReference | *No description.* | +| SecretScanningAiDetection | RepositorySecurityAndAnalysisSecretScanningAiDetectionOutputReference | *No description.* | +| SecretScanningNonProviderPatterns | RepositorySecurityAndAnalysisSecretScanningNonProviderPatternsOutputReference | *No description.* | +| SecretScanningPushProtection | RepositorySecurityAndAnalysisSecretScanningPushProtectionOutputReference | *No description.* | +| AdvancedSecurityInput | RepositorySecurityAndAnalysisAdvancedSecurity | *No description.* | +| CodeSecurityInput | RepositorySecurityAndAnalysisCodeSecurity | *No description.* | +| SecretScanningAiDetectionInput | RepositorySecurityAndAnalysisSecretScanningAiDetection | *No description.* | +| SecretScanningInput | RepositorySecurityAndAnalysisSecretScanning | *No description.* | +| SecretScanningNonProviderPatternsInput | RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns | *No description.* | +| SecretScanningPushProtectionInput | RepositorySecurityAndAnalysisSecretScanningPushProtection | *No description.* | +| InternalValue | RepositorySecurityAndAnalysis | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `AdvancedSecurity`Required + +```csharp +public RepositorySecurityAndAnalysisAdvancedSecurityOutputReference AdvancedSecurity { get; } +``` + +- *Type:* RepositorySecurityAndAnalysisAdvancedSecurityOutputReference + +--- + +##### `CodeSecurity`Required + +```csharp +public RepositorySecurityAndAnalysisCodeSecurityOutputReference CodeSecurity { get; } +``` + +- *Type:* RepositorySecurityAndAnalysisCodeSecurityOutputReference + +--- + +##### `SecretScanning`Required + +```csharp +public RepositorySecurityAndAnalysisSecretScanningOutputReference SecretScanning { get; } +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningOutputReference + +--- + +##### `SecretScanningAiDetection`Required + +```csharp +public RepositorySecurityAndAnalysisSecretScanningAiDetectionOutputReference SecretScanningAiDetection { get; } +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningAiDetectionOutputReference + +--- + +##### `SecretScanningNonProviderPatterns`Required + +```csharp +public RepositorySecurityAndAnalysisSecretScanningNonProviderPatternsOutputReference SecretScanningNonProviderPatterns { get; } +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningNonProviderPatternsOutputReference + +--- + +##### `SecretScanningPushProtection`Required + +```csharp +public RepositorySecurityAndAnalysisSecretScanningPushProtectionOutputReference SecretScanningPushProtection { get; } +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningPushProtectionOutputReference + +--- + +##### `AdvancedSecurityInput`Optional + +```csharp +public RepositorySecurityAndAnalysisAdvancedSecurity AdvancedSecurityInput { get; } +``` + +- *Type:* RepositorySecurityAndAnalysisAdvancedSecurity + +--- + +##### `CodeSecurityInput`Optional + +```csharp +public RepositorySecurityAndAnalysisCodeSecurity CodeSecurityInput { get; } +``` + +- *Type:* RepositorySecurityAndAnalysisCodeSecurity + +--- + +##### `SecretScanningAiDetectionInput`Optional + +```csharp +public RepositorySecurityAndAnalysisSecretScanningAiDetection SecretScanningAiDetectionInput { get; } +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningAiDetection + +--- + +##### `SecretScanningInput`Optional + +```csharp +public RepositorySecurityAndAnalysisSecretScanning SecretScanningInput { get; } +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanning + +--- + +##### `SecretScanningNonProviderPatternsInput`Optional + +```csharp +public RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns SecretScanningNonProviderPatternsInput { get; } +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns + +--- + +##### `SecretScanningPushProtectionInput`Optional + +```csharp +public RepositorySecurityAndAnalysisSecretScanningPushProtection SecretScanningPushProtectionInput { get; } +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningPushProtection + +--- + +##### `InternalValue`Optional + +```csharp +public RepositorySecurityAndAnalysis InternalValue { get; } +``` + +- *Type:* RepositorySecurityAndAnalysis + +--- + + +### RepositorySecurityAndAnalysisSecretScanningAiDetectionOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositorySecurityAndAnalysisSecretScanningAiDetectionOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| StatusInput | string | *No description.* | +| Status | string | *No description.* | +| InternalValue | RepositorySecurityAndAnalysisSecretScanningAiDetection | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `StatusInput`Optional + +```csharp +public string StatusInput { get; } +``` + +- *Type:* string + +--- + +##### `Status`Required + +```csharp +public string Status { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public RepositorySecurityAndAnalysisSecretScanningAiDetection InternalValue { get; } +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningAiDetection + +--- + + +### RepositorySecurityAndAnalysisSecretScanningNonProviderPatternsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositorySecurityAndAnalysisSecretScanningNonProviderPatternsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| StatusInput | string | *No description.* | +| Status | string | *No description.* | +| InternalValue | RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `StatusInput`Optional + +```csharp +public string StatusInput { get; } +``` + +- *Type:* string + +--- + +##### `Status`Required + +```csharp +public string Status { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns InternalValue { get; } +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns + +--- + + +### RepositorySecurityAndAnalysisSecretScanningOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositorySecurityAndAnalysisSecretScanningOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| StatusInput | string | *No description.* | +| Status | string | *No description.* | +| InternalValue | RepositorySecurityAndAnalysisSecretScanning | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `StatusInput`Optional + +```csharp +public string StatusInput { get; } +``` + +- *Type:* string + +--- + +##### `Status`Required + +```csharp +public string Status { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public RepositorySecurityAndAnalysisSecretScanning InternalValue { get; } +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanning + +--- + + +### RepositorySecurityAndAnalysisSecretScanningPushProtectionOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositorySecurityAndAnalysisSecretScanningPushProtectionOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| StatusInput | string | *No description.* | +| Status | string | *No description.* | +| InternalValue | RepositorySecurityAndAnalysisSecretScanningPushProtection | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `StatusInput`Optional + +```csharp +public string StatusInput { get; } +``` + +- *Type:* string + +--- + +##### `Status`Required + +```csharp +public string Status { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public RepositorySecurityAndAnalysisSecretScanningPushProtection InternalValue { get; } +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningPushProtection + +--- + + +### RepositoryTemplateOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryTemplateOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetIncludeAllBranches | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetIncludeAllBranches` + +```csharp +private void ResetIncludeAllBranches() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| IncludeAllBranchesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| OwnerInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| IncludeAllBranches | bool\|Io.Cdktn.IResolvable | *No description.* | +| Owner | string | *No description.* | +| Repository | string | *No description.* | +| InternalValue | RepositoryTemplate | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `IncludeAllBranchesInput`Optional + +```csharp +public bool|IResolvable IncludeAllBranchesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `OwnerInput`Optional + +```csharp +public string OwnerInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `IncludeAllBranches`Required + +```csharp +public bool|IResolvable IncludeAllBranches { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Owner`Required + +```csharp +public string Owner { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryTemplate InternalValue { get; } +``` + +- *Type:* RepositoryTemplate + +--- + + + diff --git a/docs/repository.java.md b/docs/repository.java.md new file mode 100644 index 000000000..fc91d4390 --- /dev/null +++ b/docs/repository.java.md @@ -0,0 +1,6914 @@ +# `repository` Submodule + +## Constructs + +### Repository + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository github_repository}. + +#### Initializers + +```java +import io.cdktn.providers.github.repository.Repository; + +Repository.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .name(java.lang.String) +// .allowAutoMerge(java.lang.Boolean|IResolvable) +// .allowForking(java.lang.Boolean|IResolvable) +// .allowMergeCommit(java.lang.Boolean|IResolvable) +// .allowRebaseMerge(java.lang.Boolean|IResolvable) +// .allowSquashMerge(java.lang.Boolean|IResolvable) +// .allowUpdateBranch(java.lang.Boolean|IResolvable) +// .archived(java.lang.Boolean|IResolvable) +// .archiveOnDestroy(java.lang.Boolean|IResolvable) +// .autoInit(java.lang.Boolean|IResolvable) +// .defaultBranch(java.lang.String) +// .deleteBranchOnMerge(java.lang.Boolean|IResolvable) +// .description(java.lang.String) +// .etag(java.lang.String) +// .fork(java.lang.String) +// .gitignoreTemplate(java.lang.String) +// .hasDiscussions(java.lang.Boolean|IResolvable) +// .hasDownloads(java.lang.Boolean|IResolvable) +// .hasIssues(java.lang.Boolean|IResolvable) +// .hasProjects(java.lang.Boolean|IResolvable) +// .hasWiki(java.lang.Boolean|IResolvable) +// .homepageUrl(java.lang.String) +// .id(java.lang.String) +// .ignoreVulnerabilityAlertsDuringRead(java.lang.Boolean|IResolvable) +// .isTemplate(java.lang.Boolean|IResolvable) +// .licenseTemplate(java.lang.String) +// .mergeCommitMessage(java.lang.String) +// .mergeCommitTitle(java.lang.String) +// .pages(RepositoryPages) +// .private(java.lang.Boolean|IResolvable) +// .securityAndAnalysis(RepositorySecurityAndAnalysis) +// .sourceOwner(java.lang.String) +// .sourceRepo(java.lang.String) +// .squashMergeCommitMessage(java.lang.String) +// .squashMergeCommitTitle(java.lang.String) +// .template(RepositoryTemplate) +// .topics(java.util.List) +// .visibility(java.lang.String) +// .vulnerabilityAlerts(java.lang.Boolean|IResolvable) +// .webCommitSignoffRequired(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 | *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 | *No description.* | +| name | java.lang.String | The name of the repository. | +| allowAutoMerge | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to allow auto-merging pull requests on the repository. | +| allowForking | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to allow private forking on the repository; | +| allowMergeCommit | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'false' to disable merge commits on the repository. | +| allowRebaseMerge | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'false' to disable rebase merges on the repository. | +| allowSquashMerge | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'false' to disable squash merges on the repository. | +| allowUpdateBranch | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to always suggest updating pull request branches. | +| archived | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Specifies if the repository should be archived. Defaults to 'false'. NOTE Currently, the API does not support unarchiving. | +| archiveOnDestroy | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to archive the repository instead of deleting on destroy. | +| autoInit | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to produce an initial commit in the repository. | +| defaultBranch | java.lang.String | Can only be set after initial repository creation, and only if the target branch exists. | +| deleteBranchOnMerge | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Automatically delete head branch after a pull request is merged. Defaults to 'false'. | +| description | java.lang.String | A description of the repository. | +| etag | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#etag Repository#etag}. | +| fork | java.lang.String | Set to 'true' to fork an existing repository. | +| gitignoreTemplate | java.lang.String | Use the name of the template without the extension. For example, 'Haskell'. | +| hasDiscussions | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to enable GitHub Discussions on the repository. Defaults to 'false'. | +| hasDownloads | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to enable the (deprecated) downloads features on the repository. | +| hasIssues | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to enable the GitHub Issues features on the repository. | +| hasProjects | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to enable the GitHub Projects features on the repository. | +| hasWiki | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to enable the GitHub Wiki features on the repository. | +| homepageUrl | java.lang.String | URL of a page describing the project. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#id Repository#id}. | +| ignoreVulnerabilityAlertsDuringRead | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#ignore_vulnerability_alerts_during_read Repository#ignore_vulnerability_alerts_during_read}. | +| isTemplate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to tell GitHub that this is a template repository. | +| licenseTemplate | java.lang.String | Use the name of the template without the extension. For example, 'mit' or 'mpl-2.0'. | +| mergeCommitMessage | java.lang.String | Can be 'PR_BODY', 'PR_TITLE', or 'BLANK' for a default merge commit message. | +| mergeCommitTitle | java.lang.String | Can be 'PR_TITLE' or 'MERGE_MESSAGE' for a default merge commit title. | +| pages | RepositoryPages | pages block. | +| private | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#private Repository#private}. | +| securityAndAnalysis | RepositorySecurityAndAnalysis | security_and_analysis block. | +| sourceOwner | java.lang.String | The owner of the source repository to fork from. | +| sourceRepo | java.lang.String | The name of the source repository to fork from. | +| squashMergeCommitMessage | java.lang.String | Can be 'PR_BODY', 'COMMIT_MESSAGES', or 'BLANK' for a default squash merge commit message. | +| squashMergeCommitTitle | java.lang.String | Can be 'PR_TITLE' or 'COMMIT_OR_PR_TITLE' for a default squash merge commit title. | +| template | RepositoryTemplate | template block. | +| topics | java.util.List | The list of topics of the repository. | +| visibility | java.lang.String | Can be 'public' or 'private'. | +| vulnerabilityAlerts | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to enable security alerts for vulnerable dependencies. | +| webCommitSignoffRequired | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Require contributors to sign off on web-based commits. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `name`Required + +- *Type:* java.lang.String + +The name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#name Repository#name} + +--- + +##### `allowAutoMerge`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to allow auto-merging pull requests on the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#allow_auto_merge Repository#allow_auto_merge} + +--- + +##### `allowForking`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to allow private forking on the repository; + +this is only relevant if the repository is owned by an organization and is private or internal. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#allow_forking Repository#allow_forking} + +--- + +##### `allowMergeCommit`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'false' to disable merge commits on the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#allow_merge_commit Repository#allow_merge_commit} + +--- + +##### `allowRebaseMerge`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'false' to disable rebase merges on the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#allow_rebase_merge Repository#allow_rebase_merge} + +--- + +##### `allowSquashMerge`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'false' to disable squash merges on the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#allow_squash_merge Repository#allow_squash_merge} + +--- + +##### `allowUpdateBranch`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to always suggest updating pull request branches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#allow_update_branch Repository#allow_update_branch} + +--- + +##### `archived`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Specifies if the repository should be archived. Defaults to 'false'. NOTE Currently, the API does not support unarchiving. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#archived Repository#archived} + +--- + +##### `archiveOnDestroy`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to archive the repository instead of deleting on destroy. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#archive_on_destroy Repository#archive_on_destroy} + +--- + +##### `autoInit`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to produce an initial commit in the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#auto_init Repository#auto_init} + +--- + +##### `defaultBranch`Optional + +- *Type:* java.lang.String + +Can only be set after initial repository creation, and only if the target branch exists. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#default_branch Repository#default_branch} + +--- + +##### `deleteBranchOnMerge`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Automatically delete head branch after a pull request is merged. Defaults to 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#delete_branch_on_merge Repository#delete_branch_on_merge} + +--- + +##### `description`Optional + +- *Type:* java.lang.String + +A description of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#description Repository#description} + +--- + +##### `etag`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#etag Repository#etag}. + +--- + +##### `fork`Optional + +- *Type:* java.lang.String + +Set to 'true' to fork an existing repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#fork Repository#fork} + +--- + +##### `gitignoreTemplate`Optional + +- *Type:* java.lang.String + +Use the name of the template without the extension. For example, 'Haskell'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#gitignore_template Repository#gitignore_template} + +--- + +##### `hasDiscussions`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to enable GitHub Discussions on the repository. Defaults to 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#has_discussions Repository#has_discussions} + +--- + +##### `hasDownloads`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to enable the (deprecated) downloads features on the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#has_downloads Repository#has_downloads} + +--- + +##### `hasIssues`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to enable the GitHub Issues features on the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#has_issues Repository#has_issues} + +--- + +##### `hasProjects`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to enable the GitHub Projects features on the repository. + +Per the GitHub documentation when in an organization that has disabled repository projects it will default to 'false' and will otherwise default to 'true'. If you specify 'true' when it has been disabled it will return an error. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#has_projects Repository#has_projects} + +--- + +##### `hasWiki`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to enable the GitHub Wiki features on the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#has_wiki Repository#has_wiki} + +--- + +##### `homepageUrl`Optional + +- *Type:* java.lang.String + +URL of a page describing the project. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#homepage_url Repository#homepage_url} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#id Repository#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. + +--- + +##### `ignoreVulnerabilityAlertsDuringRead`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/resources/repository#ignore_vulnerability_alerts_during_read Repository#ignore_vulnerability_alerts_during_read}. + +--- + +##### `isTemplate`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to tell GitHub that this is a template repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#is_template Repository#is_template} + +--- + +##### `licenseTemplate`Optional + +- *Type:* java.lang.String + +Use the name of the template without the extension. For example, 'mit' or 'mpl-2.0'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#license_template Repository#license_template} + +--- + +##### `mergeCommitMessage`Optional + +- *Type:* java.lang.String + +Can be 'PR_BODY', 'PR_TITLE', or 'BLANK' for a default merge commit message. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#merge_commit_message Repository#merge_commit_message} + +--- + +##### `mergeCommitTitle`Optional + +- *Type:* java.lang.String + +Can be 'PR_TITLE' or 'MERGE_MESSAGE' for a default merge commit title. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#merge_commit_title Repository#merge_commit_title} + +--- + +##### `pages`Optional + +- *Type:* RepositoryPages + +pages block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#pages Repository#pages} + +--- + +##### `private`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/resources/repository#private Repository#private}. + +--- + +##### `securityAndAnalysis`Optional + +- *Type:* RepositorySecurityAndAnalysis + +security_and_analysis block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#security_and_analysis Repository#security_and_analysis} + +--- + +##### `sourceOwner`Optional + +- *Type:* java.lang.String + +The owner of the source repository to fork from. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#source_owner Repository#source_owner} + +--- + +##### `sourceRepo`Optional + +- *Type:* java.lang.String + +The name of the source repository to fork from. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#source_repo Repository#source_repo} + +--- + +##### `squashMergeCommitMessage`Optional + +- *Type:* java.lang.String + +Can be 'PR_BODY', 'COMMIT_MESSAGES', or 'BLANK' for a default squash merge commit message. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#squash_merge_commit_message Repository#squash_merge_commit_message} + +--- + +##### `squashMergeCommitTitle`Optional + +- *Type:* java.lang.String + +Can be 'PR_TITLE' or 'COMMIT_OR_PR_TITLE' for a default squash merge commit title. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#squash_merge_commit_title Repository#squash_merge_commit_title} + +--- + +##### `template`Optional + +- *Type:* RepositoryTemplate + +template block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#template Repository#template} + +--- + +##### `topics`Optional + +- *Type:* java.util.List + +The list of topics of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#topics Repository#topics} + +--- + +##### `visibility`Optional + +- *Type:* java.lang.String + +Can be 'public' or 'private'. + +If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be 'internal'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#visibility Repository#visibility} + +--- + +##### `vulnerabilityAlerts`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to enable security alerts for vulnerable dependencies. + +Enabling requires alerts to be enabled on the owner level. (Note for importing: GitHub enables the alerts on all repos by default). Note that vulnerability alerts have not been successfully tested on any GitHub Enterprise instance and may be unavailable in those settings. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#vulnerability_alerts Repository#vulnerability_alerts} + +--- + +##### `webCommitSignoffRequired`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Require contributors to sign off on web-based commits. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#web_commit_signoff_required Repository#web_commit_signoff_required} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| putPages | *No description.* | +| putSecurityAndAnalysis | *No description.* | +| putTemplate | *No description.* | +| resetAllowAutoMerge | *No description.* | +| resetAllowForking | *No description.* | +| resetAllowMergeCommit | *No description.* | +| resetAllowRebaseMerge | *No description.* | +| resetAllowSquashMerge | *No description.* | +| resetAllowUpdateBranch | *No description.* | +| resetArchived | *No description.* | +| resetArchiveOnDestroy | *No description.* | +| resetAutoInit | *No description.* | +| resetDefaultBranch | *No description.* | +| resetDeleteBranchOnMerge | *No description.* | +| resetDescription | *No description.* | +| resetEtag | *No description.* | +| resetFork | *No description.* | +| resetGitignoreTemplate | *No description.* | +| resetHasDiscussions | *No description.* | +| resetHasDownloads | *No description.* | +| resetHasIssues | *No description.* | +| resetHasProjects | *No description.* | +| resetHasWiki | *No description.* | +| resetHomepageUrl | *No description.* | +| resetId | *No description.* | +| resetIgnoreVulnerabilityAlertsDuringRead | *No description.* | +| resetIsTemplate | *No description.* | +| resetLicenseTemplate | *No description.* | +| resetMergeCommitMessage | *No description.* | +| resetMergeCommitTitle | *No description.* | +| resetPages | *No description.* | +| resetPrivate | *No description.* | +| resetSecurityAndAnalysis | *No description.* | +| resetSourceOwner | *No description.* | +| resetSourceRepo | *No description.* | +| resetSquashMergeCommitMessage | *No description.* | +| resetSquashMergeCommitTitle | *No description.* | +| resetTemplate | *No description.* | +| resetTopics | *No description.* | +| resetVisibility | *No description.* | +| resetVulnerabilityAlerts | *No description.* | +| resetWebCommitSignoffRequired | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `putPages` + +```java +public void putPages(RepositoryPages value) +``` + +###### `value`Required + +- *Type:* RepositoryPages + +--- + +##### `putSecurityAndAnalysis` + +```java +public void putSecurityAndAnalysis(RepositorySecurityAndAnalysis value) +``` + +###### `value`Required + +- *Type:* RepositorySecurityAndAnalysis + +--- + +##### `putTemplate` + +```java +public void putTemplate(RepositoryTemplate value) +``` + +###### `value`Required + +- *Type:* RepositoryTemplate + +--- + +##### `resetAllowAutoMerge` + +```java +public void resetAllowAutoMerge() +``` + +##### `resetAllowForking` + +```java +public void resetAllowForking() +``` + +##### `resetAllowMergeCommit` + +```java +public void resetAllowMergeCommit() +``` + +##### `resetAllowRebaseMerge` + +```java +public void resetAllowRebaseMerge() +``` + +##### `resetAllowSquashMerge` + +```java +public void resetAllowSquashMerge() +``` + +##### `resetAllowUpdateBranch` + +```java +public void resetAllowUpdateBranch() +``` + +##### `resetArchived` + +```java +public void resetArchived() +``` + +##### `resetArchiveOnDestroy` + +```java +public void resetArchiveOnDestroy() +``` + +##### `resetAutoInit` + +```java +public void resetAutoInit() +``` + +##### `resetDefaultBranch` + +```java +public void resetDefaultBranch() +``` + +##### `resetDeleteBranchOnMerge` + +```java +public void resetDeleteBranchOnMerge() +``` + +##### `resetDescription` + +```java +public void resetDescription() +``` + +##### `resetEtag` + +```java +public void resetEtag() +``` + +##### `resetFork` + +```java +public void resetFork() +``` + +##### `resetGitignoreTemplate` + +```java +public void resetGitignoreTemplate() +``` + +##### `resetHasDiscussions` + +```java +public void resetHasDiscussions() +``` + +##### `resetHasDownloads` + +```java +public void resetHasDownloads() +``` + +##### `resetHasIssues` + +```java +public void resetHasIssues() +``` + +##### `resetHasProjects` + +```java +public void resetHasProjects() +``` + +##### `resetHasWiki` + +```java +public void resetHasWiki() +``` + +##### `resetHomepageUrl` + +```java +public void resetHomepageUrl() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetIgnoreVulnerabilityAlertsDuringRead` + +```java +public void resetIgnoreVulnerabilityAlertsDuringRead() +``` + +##### `resetIsTemplate` + +```java +public void resetIsTemplate() +``` + +##### `resetLicenseTemplate` + +```java +public void resetLicenseTemplate() +``` + +##### `resetMergeCommitMessage` + +```java +public void resetMergeCommitMessage() +``` + +##### `resetMergeCommitTitle` + +```java +public void resetMergeCommitTitle() +``` + +##### `resetPages` + +```java +public void resetPages() +``` + +##### `resetPrivate` + +```java +public void resetPrivate() +``` + +##### `resetSecurityAndAnalysis` + +```java +public void resetSecurityAndAnalysis() +``` + +##### `resetSourceOwner` + +```java +public void resetSourceOwner() +``` + +##### `resetSourceRepo` + +```java +public void resetSourceRepo() +``` + +##### `resetSquashMergeCommitMessage` + +```java +public void resetSquashMergeCommitMessage() +``` + +##### `resetSquashMergeCommitTitle` + +```java +public void resetSquashMergeCommitTitle() +``` + +##### `resetTemplate` + +```java +public void resetTemplate() +``` + +##### `resetTopics` + +```java +public void resetTopics() +``` + +##### `resetVisibility` + +```java +public void resetVisibility() +``` + +##### `resetVulnerabilityAlerts` + +```java +public void resetVulnerabilityAlerts() +``` + +##### `resetWebCommitSignoffRequired` + +```java +public void resetWebCommitSignoffRequired() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a Repository resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.repository.Repository; + +Repository.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` + +```java +import io.cdktn.providers.github.repository.Repository; + +Repository.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.repository.Repository; + +Repository.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.repository.Repository; + +Repository.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),Repository.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a Repository 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 Repository to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing Repository that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#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 Repository 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| fullName | java.lang.String | *No description.* | +| gitCloneUrl | java.lang.String | *No description.* | +| htmlUrl | java.lang.String | *No description.* | +| httpCloneUrl | java.lang.String | *No description.* | +| nodeId | java.lang.String | *No description.* | +| pages | RepositoryPagesOutputReference | *No description.* | +| primaryLanguage | java.lang.String | *No description.* | +| repoId | java.lang.Number | *No description.* | +| securityAndAnalysis | RepositorySecurityAndAnalysisOutputReference | *No description.* | +| sshCloneUrl | java.lang.String | *No description.* | +| svnUrl | java.lang.String | *No description.* | +| template | RepositoryTemplateOutputReference | *No description.* | +| allowAutoMergeInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| allowForkingInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| allowMergeCommitInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| allowRebaseMergeInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| allowSquashMergeInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| allowUpdateBranchInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| archivedInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| archiveOnDestroyInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| autoInitInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| defaultBranchInput | java.lang.String | *No description.* | +| deleteBranchOnMergeInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| descriptionInput | java.lang.String | *No description.* | +| etagInput | java.lang.String | *No description.* | +| forkInput | java.lang.String | *No description.* | +| gitignoreTemplateInput | java.lang.String | *No description.* | +| hasDiscussionsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| hasDownloadsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| hasIssuesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| hasProjectsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| hasWikiInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| homepageUrlInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| ignoreVulnerabilityAlertsDuringReadInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| isTemplateInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| licenseTemplateInput | java.lang.String | *No description.* | +| mergeCommitMessageInput | java.lang.String | *No description.* | +| mergeCommitTitleInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| pagesInput | RepositoryPages | *No description.* | +| privateInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| securityAndAnalysisInput | RepositorySecurityAndAnalysis | *No description.* | +| sourceOwnerInput | java.lang.String | *No description.* | +| sourceRepoInput | java.lang.String | *No description.* | +| squashMergeCommitMessageInput | java.lang.String | *No description.* | +| squashMergeCommitTitleInput | java.lang.String | *No description.* | +| templateInput | RepositoryTemplate | *No description.* | +| topicsInput | java.util.List | *No description.* | +| visibilityInput | java.lang.String | *No description.* | +| vulnerabilityAlertsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| webCommitSignoffRequiredInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| allowAutoMerge | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| allowForking | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| allowMergeCommit | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| allowRebaseMerge | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| allowSquashMerge | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| allowUpdateBranch | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| archived | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| archiveOnDestroy | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| autoInit | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| defaultBranch | java.lang.String | *No description.* | +| deleteBranchOnMerge | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| description | java.lang.String | *No description.* | +| etag | java.lang.String | *No description.* | +| fork | java.lang.String | *No description.* | +| gitignoreTemplate | java.lang.String | *No description.* | +| hasDiscussions | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| hasDownloads | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| hasIssues | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| hasProjects | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| hasWiki | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| homepageUrl | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| ignoreVulnerabilityAlertsDuringRead | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| isTemplate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| licenseTemplate | java.lang.String | *No description.* | +| mergeCommitMessage | java.lang.String | *No description.* | +| mergeCommitTitle | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| private | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| sourceOwner | java.lang.String | *No description.* | +| sourceRepo | java.lang.String | *No description.* | +| squashMergeCommitMessage | java.lang.String | *No description.* | +| squashMergeCommitTitle | java.lang.String | *No description.* | +| topics | java.util.List | *No description.* | +| visibility | java.lang.String | *No description.* | +| vulnerabilityAlerts | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| webCommitSignoffRequired | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `fullName`Required + +```java +public java.lang.String getFullName(); +``` + +- *Type:* java.lang.String + +--- + +##### `gitCloneUrl`Required + +```java +public java.lang.String getGitCloneUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `htmlUrl`Required + +```java +public java.lang.String getHtmlUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `httpCloneUrl`Required + +```java +public java.lang.String getHttpCloneUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `nodeId`Required + +```java +public java.lang.String getNodeId(); +``` + +- *Type:* java.lang.String + +--- + +##### `pages`Required + +```java +public RepositoryPagesOutputReference getPages(); +``` + +- *Type:* RepositoryPagesOutputReference + +--- + +##### `primaryLanguage`Required + +```java +public java.lang.String getPrimaryLanguage(); +``` + +- *Type:* java.lang.String + +--- + +##### `repoId`Required + +```java +public java.lang.Number getRepoId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `securityAndAnalysis`Required + +```java +public RepositorySecurityAndAnalysisOutputReference getSecurityAndAnalysis(); +``` + +- *Type:* RepositorySecurityAndAnalysisOutputReference + +--- + +##### `sshCloneUrl`Required + +```java +public java.lang.String getSshCloneUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `svnUrl`Required + +```java +public java.lang.String getSvnUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `template`Required + +```java +public RepositoryTemplateOutputReference getTemplate(); +``` + +- *Type:* RepositoryTemplateOutputReference + +--- + +##### `allowAutoMergeInput`Optional + +```java +public java.lang.Boolean|IResolvable getAllowAutoMergeInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `allowForkingInput`Optional + +```java +public java.lang.Boolean|IResolvable getAllowForkingInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `allowMergeCommitInput`Optional + +```java +public java.lang.Boolean|IResolvable getAllowMergeCommitInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `allowRebaseMergeInput`Optional + +```java +public java.lang.Boolean|IResolvable getAllowRebaseMergeInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `allowSquashMergeInput`Optional + +```java +public java.lang.Boolean|IResolvable getAllowSquashMergeInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `allowUpdateBranchInput`Optional + +```java +public java.lang.Boolean|IResolvable getAllowUpdateBranchInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `archivedInput`Optional + +```java +public java.lang.Boolean|IResolvable getArchivedInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `archiveOnDestroyInput`Optional + +```java +public java.lang.Boolean|IResolvable getArchiveOnDestroyInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `autoInitInput`Optional + +```java +public java.lang.Boolean|IResolvable getAutoInitInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `defaultBranchInput`Optional + +```java +public java.lang.String getDefaultBranchInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `deleteBranchOnMergeInput`Optional + +```java +public java.lang.Boolean|IResolvable getDeleteBranchOnMergeInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `descriptionInput`Optional + +```java +public java.lang.String getDescriptionInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `etagInput`Optional + +```java +public java.lang.String getEtagInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `forkInput`Optional + +```java +public java.lang.String getForkInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `gitignoreTemplateInput`Optional + +```java +public java.lang.String getGitignoreTemplateInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `hasDiscussionsInput`Optional + +```java +public java.lang.Boolean|IResolvable getHasDiscussionsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `hasDownloadsInput`Optional + +```java +public java.lang.Boolean|IResolvable getHasDownloadsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `hasIssuesInput`Optional + +```java +public java.lang.Boolean|IResolvable getHasIssuesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `hasProjectsInput`Optional + +```java +public java.lang.Boolean|IResolvable getHasProjectsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `hasWikiInput`Optional + +```java +public java.lang.Boolean|IResolvable getHasWikiInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `homepageUrlInput`Optional + +```java +public java.lang.String getHomepageUrlInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `ignoreVulnerabilityAlertsDuringReadInput`Optional + +```java +public java.lang.Boolean|IResolvable getIgnoreVulnerabilityAlertsDuringReadInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `isTemplateInput`Optional + +```java +public java.lang.Boolean|IResolvable getIsTemplateInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `licenseTemplateInput`Optional + +```java +public java.lang.String getLicenseTemplateInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `mergeCommitMessageInput`Optional + +```java +public java.lang.String getMergeCommitMessageInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `mergeCommitTitleInput`Optional + +```java +public java.lang.String getMergeCommitTitleInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `pagesInput`Optional + +```java +public RepositoryPages getPagesInput(); +``` + +- *Type:* RepositoryPages + +--- + +##### `privateInput`Optional + +```java +public java.lang.Boolean|IResolvable getPrivateInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `securityAndAnalysisInput`Optional + +```java +public RepositorySecurityAndAnalysis getSecurityAndAnalysisInput(); +``` + +- *Type:* RepositorySecurityAndAnalysis + +--- + +##### `sourceOwnerInput`Optional + +```java +public java.lang.String getSourceOwnerInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `sourceRepoInput`Optional + +```java +public java.lang.String getSourceRepoInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `squashMergeCommitMessageInput`Optional + +```java +public java.lang.String getSquashMergeCommitMessageInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `squashMergeCommitTitleInput`Optional + +```java +public java.lang.String getSquashMergeCommitTitleInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `templateInput`Optional + +```java +public RepositoryTemplate getTemplateInput(); +``` + +- *Type:* RepositoryTemplate + +--- + +##### `topicsInput`Optional + +```java +public java.util.List getTopicsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `visibilityInput`Optional + +```java +public java.lang.String getVisibilityInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `vulnerabilityAlertsInput`Optional + +```java +public java.lang.Boolean|IResolvable getVulnerabilityAlertsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `webCommitSignoffRequiredInput`Optional + +```java +public java.lang.Boolean|IResolvable getWebCommitSignoffRequiredInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `allowAutoMerge`Required + +```java +public java.lang.Boolean|IResolvable getAllowAutoMerge(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `allowForking`Required + +```java +public java.lang.Boolean|IResolvable getAllowForking(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `allowMergeCommit`Required + +```java +public java.lang.Boolean|IResolvable getAllowMergeCommit(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `allowRebaseMerge`Required + +```java +public java.lang.Boolean|IResolvable getAllowRebaseMerge(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `allowSquashMerge`Required + +```java +public java.lang.Boolean|IResolvable getAllowSquashMerge(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `allowUpdateBranch`Required + +```java +public java.lang.Boolean|IResolvable getAllowUpdateBranch(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `archived`Required + +```java +public java.lang.Boolean|IResolvable getArchived(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `archiveOnDestroy`Required + +```java +public java.lang.Boolean|IResolvable getArchiveOnDestroy(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `autoInit`Required + +```java +public java.lang.Boolean|IResolvable getAutoInit(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `defaultBranch`Required + +```java +public java.lang.String getDefaultBranch(); +``` + +- *Type:* java.lang.String + +--- + +##### `deleteBranchOnMerge`Required + +```java +public java.lang.Boolean|IResolvable getDeleteBranchOnMerge(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `fork`Required + +```java +public java.lang.String getFork(); +``` + +- *Type:* java.lang.String + +--- + +##### `gitignoreTemplate`Required + +```java +public java.lang.String getGitignoreTemplate(); +``` + +- *Type:* java.lang.String + +--- + +##### `hasDiscussions`Required + +```java +public java.lang.Boolean|IResolvable getHasDiscussions(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `hasDownloads`Required + +```java +public java.lang.Boolean|IResolvable getHasDownloads(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `hasIssues`Required + +```java +public java.lang.Boolean|IResolvable getHasIssues(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `hasProjects`Required + +```java +public java.lang.Boolean|IResolvable getHasProjects(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `hasWiki`Required + +```java +public java.lang.Boolean|IResolvable getHasWiki(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `homepageUrl`Required + +```java +public java.lang.String getHomepageUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `ignoreVulnerabilityAlertsDuringRead`Required + +```java +public java.lang.Boolean|IResolvable getIgnoreVulnerabilityAlertsDuringRead(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `isTemplate`Required + +```java +public java.lang.Boolean|IResolvable getIsTemplate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `licenseTemplate`Required + +```java +public java.lang.String getLicenseTemplate(); +``` + +- *Type:* java.lang.String + +--- + +##### `mergeCommitMessage`Required + +```java +public java.lang.String getMergeCommitMessage(); +``` + +- *Type:* java.lang.String + +--- + +##### `mergeCommitTitle`Required + +```java +public java.lang.String getMergeCommitTitle(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `private`Required + +```java +public java.lang.Boolean|IResolvable getPrivate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `sourceOwner`Required + +```java +public java.lang.String getSourceOwner(); +``` + +- *Type:* java.lang.String + +--- + +##### `sourceRepo`Required + +```java +public java.lang.String getSourceRepo(); +``` + +- *Type:* java.lang.String + +--- + +##### `squashMergeCommitMessage`Required + +```java +public java.lang.String getSquashMergeCommitMessage(); +``` + +- *Type:* java.lang.String + +--- + +##### `squashMergeCommitTitle`Required + +```java +public java.lang.String getSquashMergeCommitTitle(); +``` + +- *Type:* java.lang.String + +--- + +##### `topics`Required + +```java +public java.util.List getTopics(); +``` + +- *Type:* java.util.List + +--- + +##### `visibility`Required + +```java +public java.lang.String getVisibility(); +``` + +- *Type:* java.lang.String + +--- + +##### `vulnerabilityAlerts`Required + +```java +public java.lang.Boolean|IResolvable getVulnerabilityAlerts(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `webCommitSignoffRequired`Required + +```java +public java.lang.Boolean|IResolvable getWebCommitSignoffRequired(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### RepositoryConfig + +#### Initializer + +```java +import io.cdktn.providers.github.repository.RepositoryConfig; + +RepositoryConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .name(java.lang.String) +// .allowAutoMerge(java.lang.Boolean|IResolvable) +// .allowForking(java.lang.Boolean|IResolvable) +// .allowMergeCommit(java.lang.Boolean|IResolvable) +// .allowRebaseMerge(java.lang.Boolean|IResolvable) +// .allowSquashMerge(java.lang.Boolean|IResolvable) +// .allowUpdateBranch(java.lang.Boolean|IResolvable) +// .archived(java.lang.Boolean|IResolvable) +// .archiveOnDestroy(java.lang.Boolean|IResolvable) +// .autoInit(java.lang.Boolean|IResolvable) +// .defaultBranch(java.lang.String) +// .deleteBranchOnMerge(java.lang.Boolean|IResolvable) +// .description(java.lang.String) +// .etag(java.lang.String) +// .fork(java.lang.String) +// .gitignoreTemplate(java.lang.String) +// .hasDiscussions(java.lang.Boolean|IResolvable) +// .hasDownloads(java.lang.Boolean|IResolvable) +// .hasIssues(java.lang.Boolean|IResolvable) +// .hasProjects(java.lang.Boolean|IResolvable) +// .hasWiki(java.lang.Boolean|IResolvable) +// .homepageUrl(java.lang.String) +// .id(java.lang.String) +// .ignoreVulnerabilityAlertsDuringRead(java.lang.Boolean|IResolvable) +// .isTemplate(java.lang.Boolean|IResolvable) +// .licenseTemplate(java.lang.String) +// .mergeCommitMessage(java.lang.String) +// .mergeCommitTitle(java.lang.String) +// .pages(RepositoryPages) +// .private(java.lang.Boolean|IResolvable) +// .securityAndAnalysis(RepositorySecurityAndAnalysis) +// .sourceOwner(java.lang.String) +// .sourceRepo(java.lang.String) +// .squashMergeCommitMessage(java.lang.String) +// .squashMergeCommitTitle(java.lang.String) +// .template(RepositoryTemplate) +// .topics(java.util.List) +// .visibility(java.lang.String) +// .vulnerabilityAlerts(java.lang.Boolean|IResolvable) +// .webCommitSignoffRequired(java.lang.Boolean|IResolvable) + .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 | *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 | *No description.* | +| name | java.lang.String | The name of the repository. | +| allowAutoMerge | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to allow auto-merging pull requests on the repository. | +| allowForking | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to allow private forking on the repository; | +| allowMergeCommit | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'false' to disable merge commits on the repository. | +| allowRebaseMerge | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'false' to disable rebase merges on the repository. | +| allowSquashMerge | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'false' to disable squash merges on the repository. | +| allowUpdateBranch | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to always suggest updating pull request branches. | +| archived | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Specifies if the repository should be archived. Defaults to 'false'. NOTE Currently, the API does not support unarchiving. | +| archiveOnDestroy | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to archive the repository instead of deleting on destroy. | +| autoInit | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to produce an initial commit in the repository. | +| defaultBranch | java.lang.String | Can only be set after initial repository creation, and only if the target branch exists. | +| deleteBranchOnMerge | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Automatically delete head branch after a pull request is merged. Defaults to 'false'. | +| description | java.lang.String | A description of the repository. | +| etag | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#etag Repository#etag}. | +| fork | java.lang.String | Set to 'true' to fork an existing repository. | +| gitignoreTemplate | java.lang.String | Use the name of the template without the extension. For example, 'Haskell'. | +| hasDiscussions | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to enable GitHub Discussions on the repository. Defaults to 'false'. | +| hasDownloads | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to enable the (deprecated) downloads features on the repository. | +| hasIssues | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to enable the GitHub Issues features on the repository. | +| hasProjects | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to enable the GitHub Projects features on the repository. | +| hasWiki | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to enable the GitHub Wiki features on the repository. | +| homepageUrl | java.lang.String | URL of a page describing the project. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#id Repository#id}. | +| ignoreVulnerabilityAlertsDuringRead | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#ignore_vulnerability_alerts_during_read Repository#ignore_vulnerability_alerts_during_read}. | +| isTemplate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to tell GitHub that this is a template repository. | +| licenseTemplate | java.lang.String | Use the name of the template without the extension. For example, 'mit' or 'mpl-2.0'. | +| mergeCommitMessage | java.lang.String | Can be 'PR_BODY', 'PR_TITLE', or 'BLANK' for a default merge commit message. | +| mergeCommitTitle | java.lang.String | Can be 'PR_TITLE' or 'MERGE_MESSAGE' for a default merge commit title. | +| pages | RepositoryPages | pages block. | +| private | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#private Repository#private}. | +| securityAndAnalysis | RepositorySecurityAndAnalysis | security_and_analysis block. | +| sourceOwner | java.lang.String | The owner of the source repository to fork from. | +| sourceRepo | java.lang.String | The name of the source repository to fork from. | +| squashMergeCommitMessage | java.lang.String | Can be 'PR_BODY', 'COMMIT_MESSAGES', or 'BLANK' for a default squash merge commit message. | +| squashMergeCommitTitle | java.lang.String | Can be 'PR_TITLE' or 'COMMIT_OR_PR_TITLE' for a default squash merge commit title. | +| template | RepositoryTemplate | template block. | +| topics | java.util.List | The list of topics of the repository. | +| visibility | java.lang.String | Can be 'public' or 'private'. | +| vulnerabilityAlerts | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Set to 'true' to enable security alerts for vulnerable dependencies. | +| webCommitSignoffRequired | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Require contributors to sign off on web-based commits. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +The name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#name Repository#name} + +--- + +##### `allowAutoMerge`Optional + +```java +public java.lang.Boolean|IResolvable getAllowAutoMerge(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to allow auto-merging pull requests on the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#allow_auto_merge Repository#allow_auto_merge} + +--- + +##### `allowForking`Optional + +```java +public java.lang.Boolean|IResolvable getAllowForking(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to allow private forking on the repository; + +this is only relevant if the repository is owned by an organization and is private or internal. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#allow_forking Repository#allow_forking} + +--- + +##### `allowMergeCommit`Optional + +```java +public java.lang.Boolean|IResolvable getAllowMergeCommit(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'false' to disable merge commits on the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#allow_merge_commit Repository#allow_merge_commit} + +--- + +##### `allowRebaseMerge`Optional + +```java +public java.lang.Boolean|IResolvable getAllowRebaseMerge(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'false' to disable rebase merges on the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#allow_rebase_merge Repository#allow_rebase_merge} + +--- + +##### `allowSquashMerge`Optional + +```java +public java.lang.Boolean|IResolvable getAllowSquashMerge(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'false' to disable squash merges on the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#allow_squash_merge Repository#allow_squash_merge} + +--- + +##### `allowUpdateBranch`Optional + +```java +public java.lang.Boolean|IResolvable getAllowUpdateBranch(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to always suggest updating pull request branches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#allow_update_branch Repository#allow_update_branch} + +--- + +##### `archived`Optional + +```java +public java.lang.Boolean|IResolvable getArchived(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Specifies if the repository should be archived. Defaults to 'false'. NOTE Currently, the API does not support unarchiving. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#archived Repository#archived} + +--- + +##### `archiveOnDestroy`Optional + +```java +public java.lang.Boolean|IResolvable getArchiveOnDestroy(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to archive the repository instead of deleting on destroy. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#archive_on_destroy Repository#archive_on_destroy} + +--- + +##### `autoInit`Optional + +```java +public java.lang.Boolean|IResolvable getAutoInit(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to produce an initial commit in the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#auto_init Repository#auto_init} + +--- + +##### `defaultBranch`Optional + +```java +public java.lang.String getDefaultBranch(); +``` + +- *Type:* java.lang.String + +Can only be set after initial repository creation, and only if the target branch exists. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#default_branch Repository#default_branch} + +--- + +##### `deleteBranchOnMerge`Optional + +```java +public java.lang.Boolean|IResolvable getDeleteBranchOnMerge(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Automatically delete head branch after a pull request is merged. Defaults to 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#delete_branch_on_merge Repository#delete_branch_on_merge} + +--- + +##### `description`Optional + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +A description of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#description Repository#description} + +--- + +##### `etag`Optional + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#etag Repository#etag}. + +--- + +##### `fork`Optional + +```java +public java.lang.String getFork(); +``` + +- *Type:* java.lang.String + +Set to 'true' to fork an existing repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#fork Repository#fork} + +--- + +##### `gitignoreTemplate`Optional + +```java +public java.lang.String getGitignoreTemplate(); +``` + +- *Type:* java.lang.String + +Use the name of the template without the extension. For example, 'Haskell'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#gitignore_template Repository#gitignore_template} + +--- + +##### `hasDiscussions`Optional + +```java +public java.lang.Boolean|IResolvable getHasDiscussions(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to enable GitHub Discussions on the repository. Defaults to 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#has_discussions Repository#has_discussions} + +--- + +##### `hasDownloads`Optional + +```java +public java.lang.Boolean|IResolvable getHasDownloads(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to enable the (deprecated) downloads features on the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#has_downloads Repository#has_downloads} + +--- + +##### `hasIssues`Optional + +```java +public java.lang.Boolean|IResolvable getHasIssues(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to enable the GitHub Issues features on the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#has_issues Repository#has_issues} + +--- + +##### `hasProjects`Optional + +```java +public java.lang.Boolean|IResolvable getHasProjects(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to enable the GitHub Projects features on the repository. + +Per the GitHub documentation when in an organization that has disabled repository projects it will default to 'false' and will otherwise default to 'true'. If you specify 'true' when it has been disabled it will return an error. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#has_projects Repository#has_projects} + +--- + +##### `hasWiki`Optional + +```java +public java.lang.Boolean|IResolvable getHasWiki(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to enable the GitHub Wiki features on the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#has_wiki Repository#has_wiki} + +--- + +##### `homepageUrl`Optional + +```java +public java.lang.String getHomepageUrl(); +``` + +- *Type:* java.lang.String + +URL of a page describing the project. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#homepage_url Repository#homepage_url} + +--- + +##### `id`Optional + +```java +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/resources/repository#id Repository#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. + +--- + +##### `ignoreVulnerabilityAlertsDuringRead`Optional + +```java +public java.lang.Boolean|IResolvable getIgnoreVulnerabilityAlertsDuringRead(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#ignore_vulnerability_alerts_during_read Repository#ignore_vulnerability_alerts_during_read}. + +--- + +##### `isTemplate`Optional + +```java +public java.lang.Boolean|IResolvable getIsTemplate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to tell GitHub that this is a template repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#is_template Repository#is_template} + +--- + +##### `licenseTemplate`Optional + +```java +public java.lang.String getLicenseTemplate(); +``` + +- *Type:* java.lang.String + +Use the name of the template without the extension. For example, 'mit' or 'mpl-2.0'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#license_template Repository#license_template} + +--- + +##### `mergeCommitMessage`Optional + +```java +public java.lang.String getMergeCommitMessage(); +``` + +- *Type:* java.lang.String + +Can be 'PR_BODY', 'PR_TITLE', or 'BLANK' for a default merge commit message. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#merge_commit_message Repository#merge_commit_message} + +--- + +##### `mergeCommitTitle`Optional + +```java +public java.lang.String getMergeCommitTitle(); +``` + +- *Type:* java.lang.String + +Can be 'PR_TITLE' or 'MERGE_MESSAGE' for a default merge commit title. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#merge_commit_title Repository#merge_commit_title} + +--- + +##### `pages`Optional + +```java +public RepositoryPages getPages(); +``` + +- *Type:* RepositoryPages + +pages block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#pages Repository#pages} + +--- + +##### `private`Optional + +```java +public java.lang.Boolean|IResolvable getPrivate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#private Repository#private}. + +--- + +##### `securityAndAnalysis`Optional + +```java +public RepositorySecurityAndAnalysis getSecurityAndAnalysis(); +``` + +- *Type:* RepositorySecurityAndAnalysis + +security_and_analysis block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#security_and_analysis Repository#security_and_analysis} + +--- + +##### `sourceOwner`Optional + +```java +public java.lang.String getSourceOwner(); +``` + +- *Type:* java.lang.String + +The owner of the source repository to fork from. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#source_owner Repository#source_owner} + +--- + +##### `sourceRepo`Optional + +```java +public java.lang.String getSourceRepo(); +``` + +- *Type:* java.lang.String + +The name of the source repository to fork from. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#source_repo Repository#source_repo} + +--- + +##### `squashMergeCommitMessage`Optional + +```java +public java.lang.String getSquashMergeCommitMessage(); +``` + +- *Type:* java.lang.String + +Can be 'PR_BODY', 'COMMIT_MESSAGES', or 'BLANK' for a default squash merge commit message. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#squash_merge_commit_message Repository#squash_merge_commit_message} + +--- + +##### `squashMergeCommitTitle`Optional + +```java +public java.lang.String getSquashMergeCommitTitle(); +``` + +- *Type:* java.lang.String + +Can be 'PR_TITLE' or 'COMMIT_OR_PR_TITLE' for a default squash merge commit title. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#squash_merge_commit_title Repository#squash_merge_commit_title} + +--- + +##### `template`Optional + +```java +public RepositoryTemplate getTemplate(); +``` + +- *Type:* RepositoryTemplate + +template block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#template Repository#template} + +--- + +##### `topics`Optional + +```java +public java.util.List getTopics(); +``` + +- *Type:* java.util.List + +The list of topics of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#topics Repository#topics} + +--- + +##### `visibility`Optional + +```java +public java.lang.String getVisibility(); +``` + +- *Type:* java.lang.String + +Can be 'public' or 'private'. + +If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be 'internal'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#visibility Repository#visibility} + +--- + +##### `vulnerabilityAlerts`Optional + +```java +public java.lang.Boolean|IResolvable getVulnerabilityAlerts(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Set to 'true' to enable security alerts for vulnerable dependencies. + +Enabling requires alerts to be enabled on the owner level. (Note for importing: GitHub enables the alerts on all repos by default). Note that vulnerability alerts have not been successfully tested on any GitHub Enterprise instance and may be unavailable in those settings. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#vulnerability_alerts Repository#vulnerability_alerts} + +--- + +##### `webCommitSignoffRequired`Optional + +```java +public java.lang.Boolean|IResolvable getWebCommitSignoffRequired(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Require contributors to sign off on web-based commits. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#web_commit_signoff_required Repository#web_commit_signoff_required} + +--- + +### RepositoryPages + +#### Initializer + +```java +import io.cdktn.providers.github.repository.RepositoryPages; + +RepositoryPages.builder() +// .buildType(java.lang.String) +// .cname(java.lang.String) +// .source(RepositoryPagesSource) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| buildType | java.lang.String | The type the page should be sourced. | +| cname | java.lang.String | The custom domain for the repository. This can only be set after the repository has been created. | +| source | RepositoryPagesSource | source block. | + +--- + +##### `buildType`Optional + +```java +public java.lang.String getBuildType(); +``` + +- *Type:* java.lang.String + +The type the page should be sourced. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#build_type Repository#build_type} + +--- + +##### `cname`Optional + +```java +public java.lang.String getCname(); +``` + +- *Type:* java.lang.String + +The custom domain for the repository. This can only be set after the repository has been created. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#cname Repository#cname} + +--- + +##### `source`Optional + +```java +public RepositoryPagesSource getSource(); +``` + +- *Type:* RepositoryPagesSource + +source block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#source Repository#source} + +--- + +### RepositoryPagesSource + +#### Initializer + +```java +import io.cdktn.providers.github.repository.RepositoryPagesSource; + +RepositoryPagesSource.builder() + .branch(java.lang.String) +// .path(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| branch | java.lang.String | The repository branch used to publish the site's source files. (i.e. 'main' or 'gh-pages'). | +| path | java.lang.String | The repository directory from which the site publishes (Default: '/'). | + +--- + +##### `branch`Required + +```java +public java.lang.String getBranch(); +``` + +- *Type:* java.lang.String + +The repository branch used to publish the site's source files. (i.e. 'main' or 'gh-pages'). + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#branch Repository#branch} + +--- + +##### `path`Optional + +```java +public java.lang.String getPath(); +``` + +- *Type:* java.lang.String + +The repository directory from which the site publishes (Default: '/'). + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#path Repository#path} + +--- + +### RepositorySecurityAndAnalysis + +#### Initializer + +```java +import io.cdktn.providers.github.repository.RepositorySecurityAndAnalysis; + +RepositorySecurityAndAnalysis.builder() +// .advancedSecurity(RepositorySecurityAndAnalysisAdvancedSecurity) +// .codeSecurity(RepositorySecurityAndAnalysisCodeSecurity) +// .secretScanning(RepositorySecurityAndAnalysisSecretScanning) +// .secretScanningAiDetection(RepositorySecurityAndAnalysisSecretScanningAiDetection) +// .secretScanningNonProviderPatterns(RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns) +// .secretScanningPushProtection(RepositorySecurityAndAnalysisSecretScanningPushProtection) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| advancedSecurity | RepositorySecurityAndAnalysisAdvancedSecurity | advanced_security block. | +| codeSecurity | RepositorySecurityAndAnalysisCodeSecurity | code_security block. | +| secretScanning | RepositorySecurityAndAnalysisSecretScanning | secret_scanning block. | +| secretScanningAiDetection | RepositorySecurityAndAnalysisSecretScanningAiDetection | secret_scanning_ai_detection block. | +| secretScanningNonProviderPatterns | RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns | secret_scanning_non_provider_patterns block. | +| secretScanningPushProtection | RepositorySecurityAndAnalysisSecretScanningPushProtection | secret_scanning_push_protection block. | + +--- + +##### `advancedSecurity`Optional + +```java +public RepositorySecurityAndAnalysisAdvancedSecurity getAdvancedSecurity(); +``` + +- *Type:* RepositorySecurityAndAnalysisAdvancedSecurity + +advanced_security block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#advanced_security Repository#advanced_security} + +--- + +##### `codeSecurity`Optional + +```java +public RepositorySecurityAndAnalysisCodeSecurity getCodeSecurity(); +``` + +- *Type:* RepositorySecurityAndAnalysisCodeSecurity + +code_security block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#code_security Repository#code_security} + +--- + +##### `secretScanning`Optional + +```java +public RepositorySecurityAndAnalysisSecretScanning getSecretScanning(); +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanning + +secret_scanning block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#secret_scanning Repository#secret_scanning} + +--- + +##### `secretScanningAiDetection`Optional + +```java +public RepositorySecurityAndAnalysisSecretScanningAiDetection getSecretScanningAiDetection(); +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningAiDetection + +secret_scanning_ai_detection block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#secret_scanning_ai_detection Repository#secret_scanning_ai_detection} + +--- + +##### `secretScanningNonProviderPatterns`Optional + +```java +public RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns getSecretScanningNonProviderPatterns(); +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns + +secret_scanning_non_provider_patterns block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#secret_scanning_non_provider_patterns Repository#secret_scanning_non_provider_patterns} + +--- + +##### `secretScanningPushProtection`Optional + +```java +public RepositorySecurityAndAnalysisSecretScanningPushProtection getSecretScanningPushProtection(); +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningPushProtection + +secret_scanning_push_protection block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#secret_scanning_push_protection Repository#secret_scanning_push_protection} + +--- + +### RepositorySecurityAndAnalysisAdvancedSecurity + +#### Initializer + +```java +import io.cdktn.providers.github.repository.RepositorySecurityAndAnalysisAdvancedSecurity; + +RepositorySecurityAndAnalysisAdvancedSecurity.builder() + .status(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| status | java.lang.String | Set to 'enabled' to enable advanced security features on the repository. | + +--- + +##### `status`Required + +```java +public java.lang.String getStatus(); +``` + +- *Type:* java.lang.String + +Set to 'enabled' to enable advanced security features on the repository. + +Can be 'enabled' or 'disabled', This value being present when split licensing is enabled will error out. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#status Repository#status} + +--- + +### RepositorySecurityAndAnalysisCodeSecurity + +#### Initializer + +```java +import io.cdktn.providers.github.repository.RepositorySecurityAndAnalysisCodeSecurity; + +RepositorySecurityAndAnalysisCodeSecurity.builder() + .status(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| status | java.lang.String | Set to 'enabled' to enable code security on the repository. | + +--- + +##### `status`Required + +```java +public java.lang.String getStatus(); +``` + +- *Type:* java.lang.String + +Set to 'enabled' to enable code security on the repository. + +Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#status Repository#status} + +--- + +### RepositorySecurityAndAnalysisSecretScanning + +#### Initializer + +```java +import io.cdktn.providers.github.repository.RepositorySecurityAndAnalysisSecretScanning; + +RepositorySecurityAndAnalysisSecretScanning.builder() + .status(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| status | java.lang.String | Set to 'enabled' to enable secret scanning on the repository. | + +--- + +##### `status`Required + +```java +public java.lang.String getStatus(); +``` + +- *Type:* java.lang.String + +Set to 'enabled' to enable secret scanning on the repository. + +Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#status Repository#status} + +--- + +### RepositorySecurityAndAnalysisSecretScanningAiDetection + +#### Initializer + +```java +import io.cdktn.providers.github.repository.RepositorySecurityAndAnalysisSecretScanningAiDetection; + +RepositorySecurityAndAnalysisSecretScanningAiDetection.builder() + .status(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| status | java.lang.String | Set to 'enabled' to enable secret scanning AI detection on the repository. | + +--- + +##### `status`Required + +```java +public java.lang.String getStatus(); +``` + +- *Type:* java.lang.String + +Set to 'enabled' to enable secret scanning AI detection on the repository. + +Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#status Repository#status} + +--- + +### RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns + +#### Initializer + +```java +import io.cdktn.providers.github.repository.RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns; + +RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns.builder() + .status(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| status | java.lang.String | Set to 'enabled' to enable secret scanning non-provider patterns on the repository. | + +--- + +##### `status`Required + +```java +public java.lang.String getStatus(); +``` + +- *Type:* java.lang.String + +Set to 'enabled' to enable secret scanning non-provider patterns on the repository. + +Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#status Repository#status} + +--- + +### RepositorySecurityAndAnalysisSecretScanningPushProtection + +#### Initializer + +```java +import io.cdktn.providers.github.repository.RepositorySecurityAndAnalysisSecretScanningPushProtection; + +RepositorySecurityAndAnalysisSecretScanningPushProtection.builder() + .status(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| status | java.lang.String | Set to 'enabled' to enable secret scanning push protection on the repository. | + +--- + +##### `status`Required + +```java +public java.lang.String getStatus(); +``` + +- *Type:* java.lang.String + +Set to 'enabled' to enable secret scanning push protection on the repository. + +Can be 'enabled' or 'disabled'. If set to 'enabled', the repository's visibility must be 'public', 'security_and_analysis[0].advanced_security[0].status' must also be set to 'enabled', or your Organization must have split licensing for Advanced security. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#status Repository#status} + +--- + +### RepositoryTemplate + +#### Initializer + +```java +import io.cdktn.providers.github.repository.RepositoryTemplate; + +RepositoryTemplate.builder() + .owner(java.lang.String) + .repository(java.lang.String) +// .includeAllBranches(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| owner | java.lang.String | The GitHub organization or user the template repository is owned by. | +| repository | java.lang.String | The name of the template repository. | +| includeAllBranches | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether the new repository should include all the branches from the template repository (defaults to 'false', which includes only the default branch from the template). | + +--- + +##### `owner`Required + +```java +public java.lang.String getOwner(); +``` + +- *Type:* java.lang.String + +The GitHub organization or user the template repository is owned by. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#owner Repository#owner} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The name of the template repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#repository Repository#repository} + +--- + +##### `includeAllBranches`Optional + +```java +public java.lang.Boolean|IResolvable getIncludeAllBranches(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether the new repository should include all the branches from the template repository (defaults to 'false', which includes only the default branch from the template). + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository#include_all_branches Repository#include_all_branches} + +--- + +## Classes + +### RepositoryPagesOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository.RepositoryPagesOutputReference; + +new RepositoryPagesOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| putSource | *No description.* | +| resetBuildType | *No description.* | +| resetCname | *No description.* | +| resetSource | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `putSource` + +```java +public void putSource(RepositoryPagesSource value) +``` + +###### `value`Required + +- *Type:* RepositoryPagesSource + +--- + +##### `resetBuildType` + +```java +public void resetBuildType() +``` + +##### `resetCname` + +```java +public void resetCname() +``` + +##### `resetSource` + +```java +public void resetSource() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| custom404 | io.cdktn.cdktn.IResolvable | *No description.* | +| htmlUrl | java.lang.String | *No description.* | +| source | RepositoryPagesSourceOutputReference | *No description.* | +| status | java.lang.String | *No description.* | +| url | java.lang.String | *No description.* | +| buildTypeInput | java.lang.String | *No description.* | +| cnameInput | java.lang.String | *No description.* | +| sourceInput | RepositoryPagesSource | *No description.* | +| buildType | java.lang.String | *No description.* | +| cname | java.lang.String | *No description.* | +| internalValue | RepositoryPages | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `custom404`Required + +```java +public IResolvable getCustom404(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `htmlUrl`Required + +```java +public java.lang.String getHtmlUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `source`Required + +```java +public RepositoryPagesSourceOutputReference getSource(); +``` + +- *Type:* RepositoryPagesSourceOutputReference + +--- + +##### `status`Required + +```java +public java.lang.String getStatus(); +``` + +- *Type:* java.lang.String + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `buildTypeInput`Optional + +```java +public java.lang.String getBuildTypeInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `cnameInput`Optional + +```java +public java.lang.String getCnameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `sourceInput`Optional + +```java +public RepositoryPagesSource getSourceInput(); +``` + +- *Type:* RepositoryPagesSource + +--- + +##### `buildType`Required + +```java +public java.lang.String getBuildType(); +``` + +- *Type:* java.lang.String + +--- + +##### `cname`Required + +```java +public java.lang.String getCname(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public RepositoryPages getInternalValue(); +``` + +- *Type:* RepositoryPages + +--- + + +### RepositoryPagesSourceOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository.RepositoryPagesSourceOutputReference; + +new RepositoryPagesSourceOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetPath | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetPath` + +```java +public void resetPath() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| branchInput | java.lang.String | *No description.* | +| pathInput | java.lang.String | *No description.* | +| branch | java.lang.String | *No description.* | +| path | java.lang.String | *No description.* | +| internalValue | RepositoryPagesSource | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `branchInput`Optional + +```java +public java.lang.String getBranchInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `pathInput`Optional + +```java +public java.lang.String getPathInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `branch`Required + +```java +public java.lang.String getBranch(); +``` + +- *Type:* java.lang.String + +--- + +##### `path`Required + +```java +public java.lang.String getPath(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public RepositoryPagesSource getInternalValue(); +``` + +- *Type:* RepositoryPagesSource + +--- + + +### RepositorySecurityAndAnalysisAdvancedSecurityOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository.RepositorySecurityAndAnalysisAdvancedSecurityOutputReference; + +new RepositorySecurityAndAnalysisAdvancedSecurityOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| statusInput | java.lang.String | *No description.* | +| status | java.lang.String | *No description.* | +| internalValue | RepositorySecurityAndAnalysisAdvancedSecurity | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `statusInput`Optional + +```java +public java.lang.String getStatusInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `status`Required + +```java +public java.lang.String getStatus(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public RepositorySecurityAndAnalysisAdvancedSecurity getInternalValue(); +``` + +- *Type:* RepositorySecurityAndAnalysisAdvancedSecurity + +--- + + +### RepositorySecurityAndAnalysisCodeSecurityOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository.RepositorySecurityAndAnalysisCodeSecurityOutputReference; + +new RepositorySecurityAndAnalysisCodeSecurityOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| statusInput | java.lang.String | *No description.* | +| status | java.lang.String | *No description.* | +| internalValue | RepositorySecurityAndAnalysisCodeSecurity | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `statusInput`Optional + +```java +public java.lang.String getStatusInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `status`Required + +```java +public java.lang.String getStatus(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public RepositorySecurityAndAnalysisCodeSecurity getInternalValue(); +``` + +- *Type:* RepositorySecurityAndAnalysisCodeSecurity + +--- + + +### RepositorySecurityAndAnalysisOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository.RepositorySecurityAndAnalysisOutputReference; + +new RepositorySecurityAndAnalysisOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| putAdvancedSecurity | *No description.* | +| putCodeSecurity | *No description.* | +| putSecretScanning | *No description.* | +| putSecretScanningAiDetection | *No description.* | +| putSecretScanningNonProviderPatterns | *No description.* | +| putSecretScanningPushProtection | *No description.* | +| resetAdvancedSecurity | *No description.* | +| resetCodeSecurity | *No description.* | +| resetSecretScanning | *No description.* | +| resetSecretScanningAiDetection | *No description.* | +| resetSecretScanningNonProviderPatterns | *No description.* | +| resetSecretScanningPushProtection | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `putAdvancedSecurity` + +```java +public void putAdvancedSecurity(RepositorySecurityAndAnalysisAdvancedSecurity value) +``` + +###### `value`Required + +- *Type:* RepositorySecurityAndAnalysisAdvancedSecurity + +--- + +##### `putCodeSecurity` + +```java +public void putCodeSecurity(RepositorySecurityAndAnalysisCodeSecurity value) +``` + +###### `value`Required + +- *Type:* RepositorySecurityAndAnalysisCodeSecurity + +--- + +##### `putSecretScanning` + +```java +public void putSecretScanning(RepositorySecurityAndAnalysisSecretScanning value) +``` + +###### `value`Required + +- *Type:* RepositorySecurityAndAnalysisSecretScanning + +--- + +##### `putSecretScanningAiDetection` + +```java +public void putSecretScanningAiDetection(RepositorySecurityAndAnalysisSecretScanningAiDetection value) +``` + +###### `value`Required + +- *Type:* RepositorySecurityAndAnalysisSecretScanningAiDetection + +--- + +##### `putSecretScanningNonProviderPatterns` + +```java +public void putSecretScanningNonProviderPatterns(RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns value) +``` + +###### `value`Required + +- *Type:* RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns + +--- + +##### `putSecretScanningPushProtection` + +```java +public void putSecretScanningPushProtection(RepositorySecurityAndAnalysisSecretScanningPushProtection value) +``` + +###### `value`Required + +- *Type:* RepositorySecurityAndAnalysisSecretScanningPushProtection + +--- + +##### `resetAdvancedSecurity` + +```java +public void resetAdvancedSecurity() +``` + +##### `resetCodeSecurity` + +```java +public void resetCodeSecurity() +``` + +##### `resetSecretScanning` + +```java +public void resetSecretScanning() +``` + +##### `resetSecretScanningAiDetection` + +```java +public void resetSecretScanningAiDetection() +``` + +##### `resetSecretScanningNonProviderPatterns` + +```java +public void resetSecretScanningNonProviderPatterns() +``` + +##### `resetSecretScanningPushProtection` + +```java +public void resetSecretScanningPushProtection() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| advancedSecurity | RepositorySecurityAndAnalysisAdvancedSecurityOutputReference | *No description.* | +| codeSecurity | RepositorySecurityAndAnalysisCodeSecurityOutputReference | *No description.* | +| secretScanning | RepositorySecurityAndAnalysisSecretScanningOutputReference | *No description.* | +| secretScanningAiDetection | RepositorySecurityAndAnalysisSecretScanningAiDetectionOutputReference | *No description.* | +| secretScanningNonProviderPatterns | RepositorySecurityAndAnalysisSecretScanningNonProviderPatternsOutputReference | *No description.* | +| secretScanningPushProtection | RepositorySecurityAndAnalysisSecretScanningPushProtectionOutputReference | *No description.* | +| advancedSecurityInput | RepositorySecurityAndAnalysisAdvancedSecurity | *No description.* | +| codeSecurityInput | RepositorySecurityAndAnalysisCodeSecurity | *No description.* | +| secretScanningAiDetectionInput | RepositorySecurityAndAnalysisSecretScanningAiDetection | *No description.* | +| secretScanningInput | RepositorySecurityAndAnalysisSecretScanning | *No description.* | +| secretScanningNonProviderPatternsInput | RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns | *No description.* | +| secretScanningPushProtectionInput | RepositorySecurityAndAnalysisSecretScanningPushProtection | *No description.* | +| internalValue | RepositorySecurityAndAnalysis | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `advancedSecurity`Required + +```java +public RepositorySecurityAndAnalysisAdvancedSecurityOutputReference getAdvancedSecurity(); +``` + +- *Type:* RepositorySecurityAndAnalysisAdvancedSecurityOutputReference + +--- + +##### `codeSecurity`Required + +```java +public RepositorySecurityAndAnalysisCodeSecurityOutputReference getCodeSecurity(); +``` + +- *Type:* RepositorySecurityAndAnalysisCodeSecurityOutputReference + +--- + +##### `secretScanning`Required + +```java +public RepositorySecurityAndAnalysisSecretScanningOutputReference getSecretScanning(); +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningOutputReference + +--- + +##### `secretScanningAiDetection`Required + +```java +public RepositorySecurityAndAnalysisSecretScanningAiDetectionOutputReference getSecretScanningAiDetection(); +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningAiDetectionOutputReference + +--- + +##### `secretScanningNonProviderPatterns`Required + +```java +public RepositorySecurityAndAnalysisSecretScanningNonProviderPatternsOutputReference getSecretScanningNonProviderPatterns(); +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningNonProviderPatternsOutputReference + +--- + +##### `secretScanningPushProtection`Required + +```java +public RepositorySecurityAndAnalysisSecretScanningPushProtectionOutputReference getSecretScanningPushProtection(); +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningPushProtectionOutputReference + +--- + +##### `advancedSecurityInput`Optional + +```java +public RepositorySecurityAndAnalysisAdvancedSecurity getAdvancedSecurityInput(); +``` + +- *Type:* RepositorySecurityAndAnalysisAdvancedSecurity + +--- + +##### `codeSecurityInput`Optional + +```java +public RepositorySecurityAndAnalysisCodeSecurity getCodeSecurityInput(); +``` + +- *Type:* RepositorySecurityAndAnalysisCodeSecurity + +--- + +##### `secretScanningAiDetectionInput`Optional + +```java +public RepositorySecurityAndAnalysisSecretScanningAiDetection getSecretScanningAiDetectionInput(); +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningAiDetection + +--- + +##### `secretScanningInput`Optional + +```java +public RepositorySecurityAndAnalysisSecretScanning getSecretScanningInput(); +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanning + +--- + +##### `secretScanningNonProviderPatternsInput`Optional + +```java +public RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns getSecretScanningNonProviderPatternsInput(); +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns + +--- + +##### `secretScanningPushProtectionInput`Optional + +```java +public RepositorySecurityAndAnalysisSecretScanningPushProtection getSecretScanningPushProtectionInput(); +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningPushProtection + +--- + +##### `internalValue`Optional + +```java +public RepositorySecurityAndAnalysis getInternalValue(); +``` + +- *Type:* RepositorySecurityAndAnalysis + +--- + + +### RepositorySecurityAndAnalysisSecretScanningAiDetectionOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository.RepositorySecurityAndAnalysisSecretScanningAiDetectionOutputReference; + +new RepositorySecurityAndAnalysisSecretScanningAiDetectionOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| statusInput | java.lang.String | *No description.* | +| status | java.lang.String | *No description.* | +| internalValue | RepositorySecurityAndAnalysisSecretScanningAiDetection | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `statusInput`Optional + +```java +public java.lang.String getStatusInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `status`Required + +```java +public java.lang.String getStatus(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public RepositorySecurityAndAnalysisSecretScanningAiDetection getInternalValue(); +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningAiDetection + +--- + + +### RepositorySecurityAndAnalysisSecretScanningNonProviderPatternsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository.RepositorySecurityAndAnalysisSecretScanningNonProviderPatternsOutputReference; + +new RepositorySecurityAndAnalysisSecretScanningNonProviderPatternsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| statusInput | java.lang.String | *No description.* | +| status | java.lang.String | *No description.* | +| internalValue | RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `statusInput`Optional + +```java +public java.lang.String getStatusInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `status`Required + +```java +public java.lang.String getStatus(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns getInternalValue(); +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningNonProviderPatterns + +--- + + +### RepositorySecurityAndAnalysisSecretScanningOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository.RepositorySecurityAndAnalysisSecretScanningOutputReference; + +new RepositorySecurityAndAnalysisSecretScanningOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| statusInput | java.lang.String | *No description.* | +| status | java.lang.String | *No description.* | +| internalValue | RepositorySecurityAndAnalysisSecretScanning | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `statusInput`Optional + +```java +public java.lang.String getStatusInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `status`Required + +```java +public java.lang.String getStatus(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public RepositorySecurityAndAnalysisSecretScanning getInternalValue(); +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanning + +--- + + +### RepositorySecurityAndAnalysisSecretScanningPushProtectionOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository.RepositorySecurityAndAnalysisSecretScanningPushProtectionOutputReference; + +new RepositorySecurityAndAnalysisSecretScanningPushProtectionOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| statusInput | java.lang.String | *No description.* | +| status | java.lang.String | *No description.* | +| internalValue | RepositorySecurityAndAnalysisSecretScanningPushProtection | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `statusInput`Optional + +```java +public java.lang.String getStatusInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `status`Required + +```java +public java.lang.String getStatus(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public RepositorySecurityAndAnalysisSecretScanningPushProtection getInternalValue(); +``` + +- *Type:* RepositorySecurityAndAnalysisSecretScanningPushProtection + +--- + + +### RepositoryTemplateOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository.RepositoryTemplateOutputReference; + +new RepositoryTemplateOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetIncludeAllBranches | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetIncludeAllBranches` + +```java +public void resetIncludeAllBranches() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| includeAllBranchesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| ownerInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| includeAllBranches | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| owner | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | +| internalValue | RepositoryTemplate | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `includeAllBranchesInput`Optional + +```java +public java.lang.Boolean|IResolvable getIncludeAllBranchesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `ownerInput`Optional + +```java +public java.lang.String getOwnerInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `includeAllBranches`Required + +```java +public java.lang.Boolean|IResolvable getIncludeAllBranches(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `owner`Required + +```java +public java.lang.String getOwner(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public RepositoryTemplate getInternalValue(); +``` + +- *Type:* RepositoryTemplate + +--- + + + diff --git a/docs/repositoryAutolinkReference.csharp.md b/docs/repositoryAutolinkReference.csharp.md new file mode 100644 index 000000000..e8e2140a0 --- /dev/null +++ b/docs/repositoryAutolinkReference.csharp.md @@ -0,0 +1,1008 @@ +# `repositoryAutolinkReference` Submodule + +## Constructs + +### RepositoryAutolinkReference + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_autolink_reference github_repository_autolink_reference}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryAutolinkReference(Construct Scope, string Id, RepositoryAutolinkReferenceConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | RepositoryAutolinkReferenceConfig | *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:* RepositoryAutolinkReferenceConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | +| ResetIsAlphanumeric | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetIsAlphanumeric` + +```csharp +private void ResetIsAlphanumeric() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a RepositoryAutolinkReference resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryAutolinkReference.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` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryAutolinkReference.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryAutolinkReference.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryAutolinkReference.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a RepositoryAutolinkReference resource upon running "cdktn 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 RepositoryAutolinkReference to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing RepositoryAutolinkReference that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_autolink_reference#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the RepositoryAutolinkReference to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Etag | string | *No description.* | +| IdInput | string | *No description.* | +| IsAlphanumericInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| KeyPrefixInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| TargetUrlTemplateInput | string | *No description.* | +| Id | string | *No description.* | +| IsAlphanumeric | bool\|Io.Cdktn.IResolvable | *No description.* | +| KeyPrefix | string | *No description.* | +| Repository | string | *No description.* | +| TargetUrlTemplate | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `IsAlphanumericInput`Optional + +```csharp +public bool|IResolvable IsAlphanumericInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `KeyPrefixInput`Optional + +```csharp +public string KeyPrefixInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `TargetUrlTemplateInput`Optional + +```csharp +public string TargetUrlTemplateInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `IsAlphanumeric`Required + +```csharp +public bool|IResolvable IsAlphanumeric { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `KeyPrefix`Required + +```csharp +public string KeyPrefix { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `TargetUrlTemplate`Required + +```csharp +public string TargetUrlTemplate { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### RepositoryAutolinkReferenceConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryAutolinkReferenceConfig { + 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 KeyPrefix, + string Repository, + string TargetUrlTemplate, + string Id = null, + bool|IResolvable IsAlphanumeric = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| KeyPrefix | string | This prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit. | +| Repository | string | The repository name. | +| TargetUrlTemplate | string | The template of the target URL used for the links; | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_autolink_reference#id RepositoryAutolinkReference#id}. | +| IsAlphanumeric | bool\|Io.Cdktn.IResolvable | Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `KeyPrefix`Required + +```csharp +public string KeyPrefix { get; set; } +``` + +- *Type:* string + +This prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_autolink_reference#key_prefix RepositoryAutolinkReference#key_prefix} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_autolink_reference#repository RepositoryAutolinkReference#repository} + +--- + +##### `TargetUrlTemplate`Required + +```csharp +public string TargetUrlTemplate { get; set; } +``` + +- *Type:* string + +The template of the target URL used for the links; + +must be a valid URL and contain `` for the reference number + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_autolink_reference#target_url_template RepositoryAutolinkReference#target_url_template} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_autolink_reference#id RepositoryAutolinkReference#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. + +--- + +##### `IsAlphanumeric`Optional + +```csharp +public bool|IResolvable IsAlphanumeric { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_autolink_reference#is_alphanumeric RepositoryAutolinkReference#is_alphanumeric} + +--- + + + diff --git a/docs/repositoryAutolinkReference.java.md b/docs/repositoryAutolinkReference.java.md new file mode 100644 index 000000000..e6b08bb8e --- /dev/null +++ b/docs/repositoryAutolinkReference.java.md @@ -0,0 +1,1123 @@ +# `repositoryAutolinkReference` Submodule + +## Constructs + +### RepositoryAutolinkReference + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_autolink_reference github_repository_autolink_reference}. + +#### Initializers + +```java +import io.cdktn.providers.github.repository_autolink_reference.RepositoryAutolinkReference; + +RepositoryAutolinkReference.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .keyPrefix(java.lang.String) + .repository(java.lang.String) + .targetUrlTemplate(java.lang.String) +// .id(java.lang.String) +// .isAlphanumeric(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 | *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 | *No description.* | +| keyPrefix | java.lang.String | This prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit. | +| repository | java.lang.String | The repository name. | +| targetUrlTemplate | java.lang.String | The template of the target URL used for the links; | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_autolink_reference#id RepositoryAutolinkReference#id}. | +| isAlphanumeric | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `keyPrefix`Required + +- *Type:* java.lang.String + +This prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_autolink_reference#key_prefix RepositoryAutolinkReference#key_prefix} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_autolink_reference#repository RepositoryAutolinkReference#repository} + +--- + +##### `targetUrlTemplate`Required + +- *Type:* java.lang.String + +The template of the target URL used for the links; + +must be a valid URL and contain `` for the reference number + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_autolink_reference#target_url_template RepositoryAutolinkReference#target_url_template} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_autolink_reference#id RepositoryAutolinkReference#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. + +--- + +##### `isAlphanumeric`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_autolink_reference#is_alphanumeric RepositoryAutolinkReference#is_alphanumeric} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | +| resetIsAlphanumeric | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetIsAlphanumeric` + +```java +public void resetIsAlphanumeric() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a RepositoryAutolinkReference resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.repository_autolink_reference.RepositoryAutolinkReference; + +RepositoryAutolinkReference.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` + +```java +import io.cdktn.providers.github.repository_autolink_reference.RepositoryAutolinkReference; + +RepositoryAutolinkReference.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.repository_autolink_reference.RepositoryAutolinkReference; + +RepositoryAutolinkReference.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.repository_autolink_reference.RepositoryAutolinkReference; + +RepositoryAutolinkReference.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),RepositoryAutolinkReference.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a RepositoryAutolinkReference 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 RepositoryAutolinkReference to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing RepositoryAutolinkReference that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_autolink_reference#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 RepositoryAutolinkReference 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| etag | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| isAlphanumericInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| keyPrefixInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| targetUrlTemplateInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| isAlphanumeric | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| keyPrefix | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | +| targetUrlTemplate | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `isAlphanumericInput`Optional + +```java +public java.lang.Boolean|IResolvable getIsAlphanumericInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `keyPrefixInput`Optional + +```java +public java.lang.String getKeyPrefixInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `targetUrlTemplateInput`Optional + +```java +public java.lang.String getTargetUrlTemplateInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `isAlphanumeric`Required + +```java +public java.lang.Boolean|IResolvable getIsAlphanumeric(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `keyPrefix`Required + +```java +public java.lang.String getKeyPrefix(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `targetUrlTemplate`Required + +```java +public java.lang.String getTargetUrlTemplate(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### RepositoryAutolinkReferenceConfig + +#### Initializer + +```java +import io.cdktn.providers.github.repository_autolink_reference.RepositoryAutolinkReferenceConfig; + +RepositoryAutolinkReferenceConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .keyPrefix(java.lang.String) + .repository(java.lang.String) + .targetUrlTemplate(java.lang.String) +// .id(java.lang.String) +// .isAlphanumeric(java.lang.Boolean|IResolvable) + .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 | *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 | *No description.* | +| keyPrefix | java.lang.String | This prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit. | +| repository | java.lang.String | The repository name. | +| targetUrlTemplate | java.lang.String | The template of the target URL used for the links; | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_autolink_reference#id RepositoryAutolinkReference#id}. | +| isAlphanumeric | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `keyPrefix`Required + +```java +public java.lang.String getKeyPrefix(); +``` + +- *Type:* java.lang.String + +This prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_autolink_reference#key_prefix RepositoryAutolinkReference#key_prefix} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_autolink_reference#repository RepositoryAutolinkReference#repository} + +--- + +##### `targetUrlTemplate`Required + +```java +public java.lang.String getTargetUrlTemplate(); +``` + +- *Type:* java.lang.String + +The template of the target URL used for the links; + +must be a valid URL and contain `` for the reference number + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_autolink_reference#target_url_template RepositoryAutolinkReference#target_url_template} + +--- + +##### `id`Optional + +```java +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/resources/repository_autolink_reference#id RepositoryAutolinkReference#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. + +--- + +##### `isAlphanumeric`Optional + +```java +public java.lang.Boolean|IResolvable getIsAlphanumeric(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_autolink_reference#is_alphanumeric RepositoryAutolinkReference#is_alphanumeric} + +--- + + + diff --git a/docs/repositoryCollaborator.csharp.md b/docs/repositoryCollaborator.csharp.md new file mode 100644 index 000000000..93530eec3 --- /dev/null +++ b/docs/repositoryCollaborator.csharp.md @@ -0,0 +1,1015 @@ +# `repositoryCollaborator` Submodule + +## Constructs + +### RepositoryCollaborator + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborator github_repository_collaborator}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryCollaborator(Construct Scope, string Id, RepositoryCollaboratorConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | RepositoryCollaboratorConfig | *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:* RepositoryCollaboratorConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | +| ResetPermission | *No description.* | +| ResetPermissionDiffSuppression | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetPermission` + +```csharp +private void ResetPermission() +``` + +##### `ResetPermissionDiffSuppression` + +```csharp +private void ResetPermissionDiffSuppression() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a RepositoryCollaborator resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryCollaborator.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` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryCollaborator.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryCollaborator.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryCollaborator.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a RepositoryCollaborator resource upon running "cdktn 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 RepositoryCollaborator to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing RepositoryCollaborator that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborator#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the RepositoryCollaborator to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| InvitationId | string | *No description.* | +| IdInput | string | *No description.* | +| PermissionDiffSuppressionInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| PermissionInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| UsernameInput | string | *No description.* | +| Id | string | *No description.* | +| Permission | string | *No description.* | +| PermissionDiffSuppression | bool\|Io.Cdktn.IResolvable | *No description.* | +| Repository | string | *No description.* | +| Username | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `InvitationId`Required + +```csharp +public string InvitationId { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `PermissionDiffSuppressionInput`Optional + +```csharp +public bool|IResolvable PermissionDiffSuppressionInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `PermissionInput`Optional + +```csharp +public string PermissionInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `UsernameInput`Optional + +```csharp +public string UsernameInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Permission`Required + +```csharp +public string Permission { get; } +``` + +- *Type:* string + +--- + +##### `PermissionDiffSuppression`Required + +```csharp +public bool|IResolvable PermissionDiffSuppression { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `Username`Required + +```csharp +public string Username { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### RepositoryCollaboratorConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryCollaboratorConfig { + 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 Repository, + string Username, + string Id = null, + string Permission = null, + bool|IResolvable PermissionDiffSuppression = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | The GitHub repository. | +| Username | string | The user to add to the repository as a collaborator. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborator#id RepositoryCollaborator#id}. | +| Permission | string | The permission of the outside collaborator for the repository. | +| PermissionDiffSuppression | bool\|Io.Cdktn.IResolvable | Suppress plan diffs for triage and maintain. Defaults to 'false'. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborator#repository RepositoryCollaborator#repository} + +--- + +##### `Username`Required + +```csharp +public string Username { get; set; } +``` + +- *Type:* string + +The user to add to the repository as a collaborator. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborator#username RepositoryCollaborator#username} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborator#id RepositoryCollaborator#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. + +--- + +##### `Permission`Optional + +```csharp +public string Permission { get; set; } +``` + +- *Type:* string + +The permission of the outside collaborator for the repository. + +Must be one of 'pull', 'push', 'maintain', 'triage' or 'admin' or the name of an existing custom repository role within the organization for organization-owned repositories. Must be 'push' for personal repositories. Defaults to 'push'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborator#permission RepositoryCollaborator#permission} + +--- + +##### `PermissionDiffSuppression`Optional + +```csharp +public bool|IResolvable PermissionDiffSuppression { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Suppress plan diffs for triage and maintain. Defaults to 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborator#permission_diff_suppression RepositoryCollaborator#permission_diff_suppression} + +--- + + + diff --git a/docs/repositoryCollaborator.java.md b/docs/repositoryCollaborator.java.md new file mode 100644 index 000000000..20a39f895 --- /dev/null +++ b/docs/repositoryCollaborator.java.md @@ -0,0 +1,1130 @@ +# `repositoryCollaborator` Submodule + +## Constructs + +### RepositoryCollaborator + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborator github_repository_collaborator}. + +#### Initializers + +```java +import io.cdktn.providers.github.repository_collaborator.RepositoryCollaborator; + +RepositoryCollaborator.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) + .username(java.lang.String) +// .id(java.lang.String) +// .permission(java.lang.String) +// .permissionDiffSuppression(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 | *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 | *No description.* | +| repository | java.lang.String | The GitHub repository. | +| username | java.lang.String | The user to add to the repository as a collaborator. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborator#id RepositoryCollaborator#id}. | +| permission | java.lang.String | The permission of the outside collaborator for the repository. | +| permissionDiffSuppression | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Suppress plan diffs for triage and maintain. Defaults to 'false'. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborator#repository RepositoryCollaborator#repository} + +--- + +##### `username`Required + +- *Type:* java.lang.String + +The user to add to the repository as a collaborator. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborator#username RepositoryCollaborator#username} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborator#id RepositoryCollaborator#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. + +--- + +##### `permission`Optional + +- *Type:* java.lang.String + +The permission of the outside collaborator for the repository. + +Must be one of 'pull', 'push', 'maintain', 'triage' or 'admin' or the name of an existing custom repository role within the organization for organization-owned repositories. Must be 'push' for personal repositories. Defaults to 'push'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborator#permission RepositoryCollaborator#permission} + +--- + +##### `permissionDiffSuppression`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Suppress plan diffs for triage and maintain. Defaults to 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborator#permission_diff_suppression RepositoryCollaborator#permission_diff_suppression} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | +| resetPermission | *No description.* | +| resetPermissionDiffSuppression | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetPermission` + +```java +public void resetPermission() +``` + +##### `resetPermissionDiffSuppression` + +```java +public void resetPermissionDiffSuppression() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a RepositoryCollaborator resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.repository_collaborator.RepositoryCollaborator; + +RepositoryCollaborator.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` + +```java +import io.cdktn.providers.github.repository_collaborator.RepositoryCollaborator; + +RepositoryCollaborator.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.repository_collaborator.RepositoryCollaborator; + +RepositoryCollaborator.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.repository_collaborator.RepositoryCollaborator; + +RepositoryCollaborator.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),RepositoryCollaborator.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a RepositoryCollaborator 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 RepositoryCollaborator to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing RepositoryCollaborator that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborator#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 RepositoryCollaborator 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| invitationId | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| permissionDiffSuppressionInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| permissionInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| usernameInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| permission | java.lang.String | *No description.* | +| permissionDiffSuppression | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| repository | java.lang.String | *No description.* | +| username | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `invitationId`Required + +```java +public java.lang.String getInvitationId(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `permissionDiffSuppressionInput`Optional + +```java +public java.lang.Boolean|IResolvable getPermissionDiffSuppressionInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `permissionInput`Optional + +```java +public java.lang.String getPermissionInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `usernameInput`Optional + +```java +public java.lang.String getUsernameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `permission`Required + +```java +public java.lang.String getPermission(); +``` + +- *Type:* java.lang.String + +--- + +##### `permissionDiffSuppression`Required + +```java +public java.lang.Boolean|IResolvable getPermissionDiffSuppression(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `username`Required + +```java +public java.lang.String getUsername(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### RepositoryCollaboratorConfig + +#### Initializer + +```java +import io.cdktn.providers.github.repository_collaborator.RepositoryCollaboratorConfig; + +RepositoryCollaboratorConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) + .username(java.lang.String) +// .id(java.lang.String) +// .permission(java.lang.String) +// .permissionDiffSuppression(java.lang.Boolean|IResolvable) + .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 | *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 | *No description.* | +| repository | java.lang.String | The GitHub repository. | +| username | java.lang.String | The user to add to the repository as a collaborator. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborator#id RepositoryCollaborator#id}. | +| permission | java.lang.String | The permission of the outside collaborator for the repository. | +| permissionDiffSuppression | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Suppress plan diffs for triage and maintain. Defaults to 'false'. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborator#repository RepositoryCollaborator#repository} + +--- + +##### `username`Required + +```java +public java.lang.String getUsername(); +``` + +- *Type:* java.lang.String + +The user to add to the repository as a collaborator. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborator#username RepositoryCollaborator#username} + +--- + +##### `id`Optional + +```java +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/resources/repository_collaborator#id RepositoryCollaborator#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. + +--- + +##### `permission`Optional + +```java +public java.lang.String getPermission(); +``` + +- *Type:* java.lang.String + +The permission of the outside collaborator for the repository. + +Must be one of 'pull', 'push', 'maintain', 'triage' or 'admin' or the name of an existing custom repository role within the organization for organization-owned repositories. Must be 'push' for personal repositories. Defaults to 'push'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborator#permission RepositoryCollaborator#permission} + +--- + +##### `permissionDiffSuppression`Optional + +```java +public java.lang.Boolean|IResolvable getPermissionDiffSuppression(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Suppress plan diffs for triage and maintain. Defaults to 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborator#permission_diff_suppression RepositoryCollaborator#permission_diff_suppression} + +--- + + + diff --git a/docs/repositoryCollaborators.csharp.md b/docs/repositoryCollaborators.csharp.md new file mode 100644 index 000000000..67849c652 --- /dev/null +++ b/docs/repositoryCollaborators.csharp.md @@ -0,0 +1,2606 @@ +# `repositoryCollaborators` Submodule + +## Constructs + +### RepositoryCollaborators + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators github_repository_collaborators}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryCollaborators(Construct Scope, string Id, RepositoryCollaboratorsConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | RepositoryCollaboratorsConfig | *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:* RepositoryCollaboratorsConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| PutIgnoreTeam | *No description.* | +| PutTeam | *No description.* | +| PutUser | *No description.* | +| ResetId | *No description.* | +| ResetIgnoreTeam | *No description.* | +| ResetTeam | *No description.* | +| ResetUser | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `PutIgnoreTeam` + +```csharp +private void PutIgnoreTeam(IResolvable|RepositoryCollaboratorsIgnoreTeam[] Value) +``` + +###### `Value`Required + +- *Type:* Io.Cdktn.IResolvable|RepositoryCollaboratorsIgnoreTeam[] + +--- + +##### `PutTeam` + +```csharp +private void PutTeam(IResolvable|RepositoryCollaboratorsTeam[] Value) +``` + +###### `Value`Required + +- *Type:* Io.Cdktn.IResolvable|RepositoryCollaboratorsTeam[] + +--- + +##### `PutUser` + +```csharp +private void PutUser(IResolvable|RepositoryCollaboratorsUser[] Value) +``` + +###### `Value`Required + +- *Type:* Io.Cdktn.IResolvable|RepositoryCollaboratorsUser[] + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetIgnoreTeam` + +```csharp +private void ResetIgnoreTeam() +``` + +##### `ResetTeam` + +```csharp +private void ResetTeam() +``` + +##### `ResetUser` + +```csharp +private void ResetUser() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a RepositoryCollaborators resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryCollaborators.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` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryCollaborators.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryCollaborators.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryCollaborators.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a RepositoryCollaborators resource upon running "cdktn 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 RepositoryCollaborators to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing RepositoryCollaborators that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the RepositoryCollaborators to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| IgnoreTeam | RepositoryCollaboratorsIgnoreTeamList | *No description.* | +| InvitationIds | Io.Cdktn.StringMap | *No description.* | +| RepositoryId | double | *No description.* | +| Team | RepositoryCollaboratorsTeamList | *No description.* | +| User | RepositoryCollaboratorsUserList | *No description.* | +| IdInput | string | *No description.* | +| IgnoreTeamInput | Io.Cdktn.IResolvable\|RepositoryCollaboratorsIgnoreTeam[] | *No description.* | +| RepositoryInput | string | *No description.* | +| TeamInput | Io.Cdktn.IResolvable\|RepositoryCollaboratorsTeam[] | *No description.* | +| UserInput | Io.Cdktn.IResolvable\|RepositoryCollaboratorsUser[] | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `IgnoreTeam`Required + +```csharp +public RepositoryCollaboratorsIgnoreTeamList IgnoreTeam { get; } +``` + +- *Type:* RepositoryCollaboratorsIgnoreTeamList + +--- + +##### `InvitationIds`Required + +```csharp +public StringMap InvitationIds { get; } +``` + +- *Type:* Io.Cdktn.StringMap + +--- + +##### `RepositoryId`Required + +```csharp +public double RepositoryId { get; } +``` + +- *Type:* double + +--- + +##### `Team`Required + +```csharp +public RepositoryCollaboratorsTeamList Team { get; } +``` + +- *Type:* RepositoryCollaboratorsTeamList + +--- + +##### `User`Required + +```csharp +public RepositoryCollaboratorsUserList User { get; } +``` + +- *Type:* RepositoryCollaboratorsUserList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `IgnoreTeamInput`Optional + +```csharp +public IResolvable|RepositoryCollaboratorsIgnoreTeam[] IgnoreTeamInput { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryCollaboratorsIgnoreTeam[] + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `TeamInput`Optional + +```csharp +public IResolvable|RepositoryCollaboratorsTeam[] TeamInput { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryCollaboratorsTeam[] + +--- + +##### `UserInput`Optional + +```csharp +public IResolvable|RepositoryCollaboratorsUser[] UserInput { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryCollaboratorsUser[] + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### RepositoryCollaboratorsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryCollaboratorsConfig { + 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 Repository, + string Id = null, + IResolvable|RepositoryCollaboratorsIgnoreTeam[] IgnoreTeam = null, + IResolvable|RepositoryCollaboratorsTeam[] Team = null, + IResolvable|RepositoryCollaboratorsUser[] User = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | Name of the repository. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#id RepositoryCollaborators#id}. | +| IgnoreTeam | Io.Cdktn.IResolvable\|RepositoryCollaboratorsIgnoreTeam[] | ignore_team block. | +| Team | Io.Cdktn.IResolvable\|RepositoryCollaboratorsTeam[] | team block. | +| User | Io.Cdktn.IResolvable\|RepositoryCollaboratorsUser[] | user block. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#repository RepositoryCollaborators#repository} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#id RepositoryCollaborators#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. + +--- + +##### `IgnoreTeam`Optional + +```csharp +public IResolvable|RepositoryCollaboratorsIgnoreTeam[] IgnoreTeam { get; set; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryCollaboratorsIgnoreTeam[] + +ignore_team block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#ignore_team RepositoryCollaborators#ignore_team} + +--- + +##### `Team`Optional + +```csharp +public IResolvable|RepositoryCollaboratorsTeam[] Team { get; set; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryCollaboratorsTeam[] + +team block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#team RepositoryCollaborators#team} + +--- + +##### `User`Optional + +```csharp +public IResolvable|RepositoryCollaboratorsUser[] User { get; set; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryCollaboratorsUser[] + +user block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#user RepositoryCollaborators#user} + +--- + +### RepositoryCollaboratorsIgnoreTeam + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryCollaboratorsIgnoreTeam { + string TeamId +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TeamId | string | ID or slug of the team to ignore. | + +--- + +##### `TeamId`Required + +```csharp +public string TeamId { get; set; } +``` + +- *Type:* string + +ID or slug of the team to ignore. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#team_id RepositoryCollaborators#team_id} + +--- + +### RepositoryCollaboratorsTeam + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryCollaboratorsTeam { + string TeamId, + string Permission = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TeamId | string | Team ID or slug to add to the repository as a collaborator. | +| Permission | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#permission RepositoryCollaborators#permission}. | + +--- + +##### `TeamId`Required + +```csharp +public string TeamId { get; set; } +``` + +- *Type:* string + +Team ID or slug to add to the repository as a collaborator. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#team_id RepositoryCollaborators#team_id} + +--- + +##### `Permission`Optional + +```csharp +public string Permission { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#permission RepositoryCollaborators#permission}. + +--- + +### RepositoryCollaboratorsUser + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryCollaboratorsUser { + string Username, + string Permission = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Username | string | (Required) The user to add to the repository as a collaborator. | +| Permission | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#permission RepositoryCollaborators#permission}. | + +--- + +##### `Username`Required + +```csharp +public string Username { get; set; } +``` + +- *Type:* string + +(Required) The user to add to the repository as a collaborator. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#username RepositoryCollaborators#username} + +--- + +##### `Permission`Optional + +```csharp +public string Permission { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#permission RepositoryCollaborators#permission}. + +--- + +## Classes + +### RepositoryCollaboratorsIgnoreTeamList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryCollaboratorsIgnoreTeamList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private RepositoryCollaboratorsIgnoreTeamOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|RepositoryCollaboratorsIgnoreTeam[] | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|RepositoryCollaboratorsIgnoreTeam[] InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryCollaboratorsIgnoreTeam[] + +--- + + +### RepositoryCollaboratorsIgnoreTeamOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryCollaboratorsIgnoreTeamOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| TeamIdInput | string | *No description.* | +| TeamId | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|RepositoryCollaboratorsIgnoreTeam | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `TeamIdInput`Optional + +```csharp +public string TeamIdInput { get; } +``` + +- *Type:* string + +--- + +##### `TeamId`Required + +```csharp +public string TeamId { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|RepositoryCollaboratorsIgnoreTeam InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryCollaboratorsIgnoreTeam + +--- + + +### RepositoryCollaboratorsTeamList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryCollaboratorsTeamList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private RepositoryCollaboratorsTeamOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|RepositoryCollaboratorsTeam[] | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|RepositoryCollaboratorsTeam[] InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryCollaboratorsTeam[] + +--- + + +### RepositoryCollaboratorsTeamOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryCollaboratorsTeamOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetPermission | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetPermission` + +```csharp +private void ResetPermission() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| PermissionInput | string | *No description.* | +| TeamIdInput | string | *No description.* | +| Permission | string | *No description.* | +| TeamId | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|RepositoryCollaboratorsTeam | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `PermissionInput`Optional + +```csharp +public string PermissionInput { get; } +``` + +- *Type:* string + +--- + +##### `TeamIdInput`Optional + +```csharp +public string TeamIdInput { get; } +``` + +- *Type:* string + +--- + +##### `Permission`Required + +```csharp +public string Permission { get; } +``` + +- *Type:* string + +--- + +##### `TeamId`Required + +```csharp +public string TeamId { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|RepositoryCollaboratorsTeam InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryCollaboratorsTeam + +--- + + +### RepositoryCollaboratorsUserList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryCollaboratorsUserList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private RepositoryCollaboratorsUserOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|RepositoryCollaboratorsUser[] | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|RepositoryCollaboratorsUser[] InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryCollaboratorsUser[] + +--- + + +### RepositoryCollaboratorsUserOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryCollaboratorsUserOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetPermission | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetPermission` + +```csharp +private void ResetPermission() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| PermissionInput | string | *No description.* | +| UsernameInput | string | *No description.* | +| Permission | string | *No description.* | +| Username | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|RepositoryCollaboratorsUser | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `PermissionInput`Optional + +```csharp +public string PermissionInput { get; } +``` + +- *Type:* string + +--- + +##### `UsernameInput`Optional + +```csharp +public string UsernameInput { get; } +``` + +- *Type:* string + +--- + +##### `Permission`Required + +```csharp +public string Permission { get; } +``` + +- *Type:* string + +--- + +##### `Username`Required + +```csharp +public string Username { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|RepositoryCollaboratorsUser InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryCollaboratorsUser + +--- + + + diff --git a/docs/repositoryCollaborators.java.md b/docs/repositoryCollaborators.java.md new file mode 100644 index 000000000..9f811426e --- /dev/null +++ b/docs/repositoryCollaborators.java.md @@ -0,0 +1,2719 @@ +# `repositoryCollaborators` Submodule + +## Constructs + +### RepositoryCollaborators + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators github_repository_collaborators}. + +#### Initializers + +```java +import io.cdktn.providers.github.repository_collaborators.RepositoryCollaborators; + +RepositoryCollaborators.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(java.lang.String) +// .ignoreTeam(IResolvable|java.util.List) +// .team(IResolvable|java.util.List) +// .user(IResolvable|java.util.List) + .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 | *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 | *No description.* | +| repository | java.lang.String | Name of the repository. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#id RepositoryCollaborators#id}. | +| ignoreTeam | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryCollaboratorsIgnoreTeam> | ignore_team block. | +| team | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryCollaboratorsTeam> | team block. | +| user | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryCollaboratorsUser> | user block. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#repository RepositoryCollaborators#repository} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#id RepositoryCollaborators#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. + +--- + +##### `ignoreTeam`Optional + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryCollaboratorsIgnoreTeam> + +ignore_team block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#ignore_team RepositoryCollaborators#ignore_team} + +--- + +##### `team`Optional + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryCollaboratorsTeam> + +team block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#team RepositoryCollaborators#team} + +--- + +##### `user`Optional + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryCollaboratorsUser> + +user block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#user RepositoryCollaborators#user} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| putIgnoreTeam | *No description.* | +| putTeam | *No description.* | +| putUser | *No description.* | +| resetId | *No description.* | +| resetIgnoreTeam | *No description.* | +| resetTeam | *No description.* | +| resetUser | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `putIgnoreTeam` + +```java +public void putIgnoreTeam(IResolvable|java.util.List value) +``` + +###### `value`Required + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryCollaboratorsIgnoreTeam> + +--- + +##### `putTeam` + +```java +public void putTeam(IResolvable|java.util.List value) +``` + +###### `value`Required + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryCollaboratorsTeam> + +--- + +##### `putUser` + +```java +public void putUser(IResolvable|java.util.List value) +``` + +###### `value`Required + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryCollaboratorsUser> + +--- + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetIgnoreTeam` + +```java +public void resetIgnoreTeam() +``` + +##### `resetTeam` + +```java +public void resetTeam() +``` + +##### `resetUser` + +```java +public void resetUser() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a RepositoryCollaborators resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.repository_collaborators.RepositoryCollaborators; + +RepositoryCollaborators.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` + +```java +import io.cdktn.providers.github.repository_collaborators.RepositoryCollaborators; + +RepositoryCollaborators.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.repository_collaborators.RepositoryCollaborators; + +RepositoryCollaborators.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.repository_collaborators.RepositoryCollaborators; + +RepositoryCollaborators.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),RepositoryCollaborators.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a RepositoryCollaborators 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 RepositoryCollaborators to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing RepositoryCollaborators that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#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 RepositoryCollaborators 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| ignoreTeam | RepositoryCollaboratorsIgnoreTeamList | *No description.* | +| invitationIds | io.cdktn.cdktn.StringMap | *No description.* | +| repositoryId | java.lang.Number | *No description.* | +| team | RepositoryCollaboratorsTeamList | *No description.* | +| user | RepositoryCollaboratorsUserList | *No description.* | +| idInput | java.lang.String | *No description.* | +| ignoreTeamInput | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryCollaboratorsIgnoreTeam> | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| teamInput | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryCollaboratorsTeam> | *No description.* | +| userInput | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryCollaboratorsUser> | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `ignoreTeam`Required + +```java +public RepositoryCollaboratorsIgnoreTeamList getIgnoreTeam(); +``` + +- *Type:* RepositoryCollaboratorsIgnoreTeamList + +--- + +##### `invitationIds`Required + +```java +public StringMap getInvitationIds(); +``` + +- *Type:* io.cdktn.cdktn.StringMap + +--- + +##### `repositoryId`Required + +```java +public java.lang.Number getRepositoryId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `team`Required + +```java +public RepositoryCollaboratorsTeamList getTeam(); +``` + +- *Type:* RepositoryCollaboratorsTeamList + +--- + +##### `user`Required + +```java +public RepositoryCollaboratorsUserList getUser(); +``` + +- *Type:* RepositoryCollaboratorsUserList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `ignoreTeamInput`Optional + +```java +public IResolvable|java.util.List getIgnoreTeamInput(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryCollaboratorsIgnoreTeam> + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `teamInput`Optional + +```java +public IResolvable|java.util.List getTeamInput(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryCollaboratorsTeam> + +--- + +##### `userInput`Optional + +```java +public IResolvable|java.util.List getUserInput(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryCollaboratorsUser> + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### RepositoryCollaboratorsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.repository_collaborators.RepositoryCollaboratorsConfig; + +RepositoryCollaboratorsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .id(java.lang.String) +// .ignoreTeam(IResolvable|java.util.List) +// .team(IResolvable|java.util.List) +// .user(IResolvable|java.util.List) + .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 | *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 | *No description.* | +| repository | java.lang.String | Name of the repository. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#id RepositoryCollaborators#id}. | +| ignoreTeam | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryCollaboratorsIgnoreTeam> | ignore_team block. | +| team | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryCollaboratorsTeam> | team block. | +| user | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryCollaboratorsUser> | user block. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Name of the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#repository RepositoryCollaborators#repository} + +--- + +##### `id`Optional + +```java +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/resources/repository_collaborators#id RepositoryCollaborators#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. + +--- + +##### `ignoreTeam`Optional + +```java +public IResolvable|java.util.List getIgnoreTeam(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryCollaboratorsIgnoreTeam> + +ignore_team block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#ignore_team RepositoryCollaborators#ignore_team} + +--- + +##### `team`Optional + +```java +public IResolvable|java.util.List getTeam(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryCollaboratorsTeam> + +team block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#team RepositoryCollaborators#team} + +--- + +##### `user`Optional + +```java +public IResolvable|java.util.List getUser(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryCollaboratorsUser> + +user block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#user RepositoryCollaborators#user} + +--- + +### RepositoryCollaboratorsIgnoreTeam + +#### Initializer + +```java +import io.cdktn.providers.github.repository_collaborators.RepositoryCollaboratorsIgnoreTeam; + +RepositoryCollaboratorsIgnoreTeam.builder() + .teamId(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| teamId | java.lang.String | ID or slug of the team to ignore. | + +--- + +##### `teamId`Required + +```java +public java.lang.String getTeamId(); +``` + +- *Type:* java.lang.String + +ID or slug of the team to ignore. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#team_id RepositoryCollaborators#team_id} + +--- + +### RepositoryCollaboratorsTeam + +#### Initializer + +```java +import io.cdktn.providers.github.repository_collaborators.RepositoryCollaboratorsTeam; + +RepositoryCollaboratorsTeam.builder() + .teamId(java.lang.String) +// .permission(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| teamId | java.lang.String | Team ID or slug to add to the repository as a collaborator. | +| permission | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#permission RepositoryCollaborators#permission}. | + +--- + +##### `teamId`Required + +```java +public java.lang.String getTeamId(); +``` + +- *Type:* java.lang.String + +Team ID or slug to add to the repository as a collaborator. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#team_id RepositoryCollaborators#team_id} + +--- + +##### `permission`Optional + +```java +public java.lang.String getPermission(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#permission RepositoryCollaborators#permission}. + +--- + +### RepositoryCollaboratorsUser + +#### Initializer + +```java +import io.cdktn.providers.github.repository_collaborators.RepositoryCollaboratorsUser; + +RepositoryCollaboratorsUser.builder() + .username(java.lang.String) +// .permission(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| username | java.lang.String | (Required) The user to add to the repository as a collaborator. | +| permission | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#permission RepositoryCollaborators#permission}. | + +--- + +##### `username`Required + +```java +public java.lang.String getUsername(); +``` + +- *Type:* java.lang.String + +(Required) The user to add to the repository as a collaborator. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#username RepositoryCollaborators#username} + +--- + +##### `permission`Optional + +```java +public java.lang.String getPermission(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_collaborators#permission RepositoryCollaborators#permission}. + +--- + +## Classes + +### RepositoryCollaboratorsIgnoreTeamList + +#### Initializers + +```java +import io.cdktn.providers.github.repository_collaborators.RepositoryCollaboratorsIgnoreTeamList; + +new RepositoryCollaboratorsIgnoreTeamList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public RepositoryCollaboratorsIgnoreTeamOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryCollaboratorsIgnoreTeam> | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|java.util.List getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryCollaboratorsIgnoreTeam> + +--- + + +### RepositoryCollaboratorsIgnoreTeamOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_collaborators.RepositoryCollaboratorsIgnoreTeamOutputReference; + +new RepositoryCollaboratorsIgnoreTeamOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| teamIdInput | java.lang.String | *No description.* | +| teamId | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|RepositoryCollaboratorsIgnoreTeam | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `teamIdInput`Optional + +```java +public java.lang.String getTeamIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `teamId`Required + +```java +public java.lang.String getTeamId(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|RepositoryCollaboratorsIgnoreTeam getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|RepositoryCollaboratorsIgnoreTeam + +--- + + +### RepositoryCollaboratorsTeamList + +#### Initializers + +```java +import io.cdktn.providers.github.repository_collaborators.RepositoryCollaboratorsTeamList; + +new RepositoryCollaboratorsTeamList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public RepositoryCollaboratorsTeamOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryCollaboratorsTeam> | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|java.util.List getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryCollaboratorsTeam> + +--- + + +### RepositoryCollaboratorsTeamOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_collaborators.RepositoryCollaboratorsTeamOutputReference; + +new RepositoryCollaboratorsTeamOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetPermission | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetPermission` + +```java +public void resetPermission() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| permissionInput | java.lang.String | *No description.* | +| teamIdInput | java.lang.String | *No description.* | +| permission | java.lang.String | *No description.* | +| teamId | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|RepositoryCollaboratorsTeam | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `permissionInput`Optional + +```java +public java.lang.String getPermissionInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `teamIdInput`Optional + +```java +public java.lang.String getTeamIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `permission`Required + +```java +public java.lang.String getPermission(); +``` + +- *Type:* java.lang.String + +--- + +##### `teamId`Required + +```java +public java.lang.String getTeamId(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|RepositoryCollaboratorsTeam getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|RepositoryCollaboratorsTeam + +--- + + +### RepositoryCollaboratorsUserList + +#### Initializers + +```java +import io.cdktn.providers.github.repository_collaborators.RepositoryCollaboratorsUserList; + +new RepositoryCollaboratorsUserList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public RepositoryCollaboratorsUserOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryCollaboratorsUser> | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|java.util.List getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryCollaboratorsUser> + +--- + + +### RepositoryCollaboratorsUserOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_collaborators.RepositoryCollaboratorsUserOutputReference; + +new RepositoryCollaboratorsUserOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetPermission | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetPermission` + +```java +public void resetPermission() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| permissionInput | java.lang.String | *No description.* | +| usernameInput | java.lang.String | *No description.* | +| permission | java.lang.String | *No description.* | +| username | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|RepositoryCollaboratorsUser | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `permissionInput`Optional + +```java +public java.lang.String getPermissionInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `usernameInput`Optional + +```java +public java.lang.String getUsernameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `permission`Required + +```java +public java.lang.String getPermission(); +``` + +- *Type:* java.lang.String + +--- + +##### `username`Required + +```java +public java.lang.String getUsername(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|RepositoryCollaboratorsUser getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|RepositoryCollaboratorsUser + +--- + + + diff --git a/docs/repositoryCustomProperty.csharp.md b/docs/repositoryCustomProperty.csharp.md new file mode 100644 index 000000000..d2afecd20 --- /dev/null +++ b/docs/repositoryCustomProperty.csharp.md @@ -0,0 +1,988 @@ +# `repositoryCustomProperty` Submodule + +## Constructs + +### RepositoryCustomProperty + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_custom_property github_repository_custom_property}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryCustomProperty(Construct Scope, string Id, RepositoryCustomPropertyConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | RepositoryCustomPropertyConfig | *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:* RepositoryCustomPropertyConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a RepositoryCustomProperty resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryCustomProperty.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` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryCustomProperty.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryCustomProperty.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryCustomProperty.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a RepositoryCustomProperty resource upon running "cdktn 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 RepositoryCustomProperty to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing RepositoryCustomProperty that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_custom_property#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the RepositoryCustomProperty to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| IdInput | string | *No description.* | +| PropertyNameInput | string | *No description.* | +| PropertyTypeInput | string | *No description.* | +| PropertyValueInput | string[] | *No description.* | +| RepositoryInput | string | *No description.* | +| Id | string | *No description.* | +| PropertyName | string | *No description.* | +| PropertyType | string | *No description.* | +| PropertyValue | string[] | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `PropertyNameInput`Optional + +```csharp +public string PropertyNameInput { get; } +``` + +- *Type:* string + +--- + +##### `PropertyTypeInput`Optional + +```csharp +public string PropertyTypeInput { get; } +``` + +- *Type:* string + +--- + +##### `PropertyValueInput`Optional + +```csharp +public string[] PropertyValueInput { get; } +``` + +- *Type:* string[] + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `PropertyName`Required + +```csharp +public string PropertyName { get; } +``` + +- *Type:* string + +--- + +##### `PropertyType`Required + +```csharp +public string PropertyType { get; } +``` + +- *Type:* string + +--- + +##### `PropertyValue`Required + +```csharp +public string[] PropertyValue { get; } +``` + +- *Type:* string[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### RepositoryCustomPropertyConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryCustomPropertyConfig { + 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 PropertyName, + string PropertyType, + string[] PropertyValue, + string Repository, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| PropertyName | string | Name of the custom property. | +| PropertyType | string | Type of the custom property. | +| PropertyValue | string[] | Value of the custom property. | +| Repository | string | Name of the repository which the custom properties should be on. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_custom_property#id RepositoryCustomProperty#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `PropertyName`Required + +```csharp +public string PropertyName { get; set; } +``` + +- *Type:* string + +Name of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_custom_property#property_name RepositoryCustomProperty#property_name} + +--- + +##### `PropertyType`Required + +```csharp +public string PropertyType { get; set; } +``` + +- *Type:* string + +Type of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_custom_property#property_type RepositoryCustomProperty#property_type} + +--- + +##### `PropertyValue`Required + +```csharp +public string[] PropertyValue { get; set; } +``` + +- *Type:* string[] + +Value of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_custom_property#property_value RepositoryCustomProperty#property_value} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Name of the repository which the custom properties should be on. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_custom_property#repository RepositoryCustomProperty#repository} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_custom_property#id RepositoryCustomProperty#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. + +--- + + + diff --git a/docs/repositoryCustomProperty.java.md b/docs/repositoryCustomProperty.java.md new file mode 100644 index 000000000..dfe54350c --- /dev/null +++ b/docs/repositoryCustomProperty.java.md @@ -0,0 +1,1101 @@ +# `repositoryCustomProperty` Submodule + +## Constructs + +### RepositoryCustomProperty + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_custom_property github_repository_custom_property}. + +#### Initializers + +```java +import io.cdktn.providers.github.repository_custom_property.RepositoryCustomProperty; + +RepositoryCustomProperty.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .propertyName(java.lang.String) + .propertyType(java.lang.String) + .propertyValue(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| propertyName | java.lang.String | Name of the custom property. | +| propertyType | java.lang.String | Type of the custom property. | +| propertyValue | java.util.List | Value of the custom property. | +| repository | java.lang.String | Name of the repository which the custom properties should be on. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_custom_property#id RepositoryCustomProperty#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `propertyName`Required + +- *Type:* java.lang.String + +Name of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_custom_property#property_name RepositoryCustomProperty#property_name} + +--- + +##### `propertyType`Required + +- *Type:* java.lang.String + +Type of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_custom_property#property_type RepositoryCustomProperty#property_type} + +--- + +##### `propertyValue`Required + +- *Type:* java.util.List + +Value of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_custom_property#property_value RepositoryCustomProperty#property_value} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Name of the repository which the custom properties should be on. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_custom_property#repository RepositoryCustomProperty#repository} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_custom_property#id RepositoryCustomProperty#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a RepositoryCustomProperty resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.repository_custom_property.RepositoryCustomProperty; + +RepositoryCustomProperty.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` + +```java +import io.cdktn.providers.github.repository_custom_property.RepositoryCustomProperty; + +RepositoryCustomProperty.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.repository_custom_property.RepositoryCustomProperty; + +RepositoryCustomProperty.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.repository_custom_property.RepositoryCustomProperty; + +RepositoryCustomProperty.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),RepositoryCustomProperty.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a RepositoryCustomProperty 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 RepositoryCustomProperty to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing RepositoryCustomProperty that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_custom_property#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 RepositoryCustomProperty 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| idInput | java.lang.String | *No description.* | +| propertyNameInput | java.lang.String | *No description.* | +| propertyTypeInput | java.lang.String | *No description.* | +| propertyValueInput | java.util.List | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| propertyName | java.lang.String | *No description.* | +| propertyType | java.lang.String | *No description.* | +| propertyValue | java.util.List | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `propertyNameInput`Optional + +```java +public java.lang.String getPropertyNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `propertyTypeInput`Optional + +```java +public java.lang.String getPropertyTypeInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `propertyValueInput`Optional + +```java +public java.util.List getPropertyValueInput(); +``` + +- *Type:* java.util.List + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `propertyName`Required + +```java +public java.lang.String getPropertyName(); +``` + +- *Type:* java.lang.String + +--- + +##### `propertyType`Required + +```java +public java.lang.String getPropertyType(); +``` + +- *Type:* java.lang.String + +--- + +##### `propertyValue`Required + +```java +public java.util.List getPropertyValue(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### RepositoryCustomPropertyConfig + +#### Initializer + +```java +import io.cdktn.providers.github.repository_custom_property.RepositoryCustomPropertyConfig; + +RepositoryCustomPropertyConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .propertyName(java.lang.String) + .propertyType(java.lang.String) + .propertyValue(java.util.List) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| propertyName | java.lang.String | Name of the custom property. | +| propertyType | java.lang.String | Type of the custom property. | +| propertyValue | java.util.List | Value of the custom property. | +| repository | java.lang.String | Name of the repository which the custom properties should be on. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_custom_property#id RepositoryCustomProperty#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `propertyName`Required + +```java +public java.lang.String getPropertyName(); +``` + +- *Type:* java.lang.String + +Name of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_custom_property#property_name RepositoryCustomProperty#property_name} + +--- + +##### `propertyType`Required + +```java +public java.lang.String getPropertyType(); +``` + +- *Type:* java.lang.String + +Type of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_custom_property#property_type RepositoryCustomProperty#property_type} + +--- + +##### `propertyValue`Required + +```java +public java.util.List getPropertyValue(); +``` + +- *Type:* java.util.List + +Value of the custom property. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_custom_property#property_value RepositoryCustomProperty#property_value} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Name of the repository which the custom properties should be on. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_custom_property#repository RepositoryCustomProperty#repository} + +--- + +##### `id`Optional + +```java +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/resources/repository_custom_property#id RepositoryCustomProperty#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. + +--- + + + diff --git a/docs/repositoryDependabotSecurityUpdates.csharp.md b/docs/repositoryDependabotSecurityUpdates.csharp.md new file mode 100644 index 000000000..295da25bb --- /dev/null +++ b/docs/repositoryDependabotSecurityUpdates.csharp.md @@ -0,0 +1,912 @@ +# `repositoryDependabotSecurityUpdates` Submodule + +## Constructs + +### RepositoryDependabotSecurityUpdates + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_dependabot_security_updates github_repository_dependabot_security_updates}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryDependabotSecurityUpdates(Construct Scope, string Id, RepositoryDependabotSecurityUpdatesConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | RepositoryDependabotSecurityUpdatesConfig | *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:* RepositoryDependabotSecurityUpdatesConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a RepositoryDependabotSecurityUpdates resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryDependabotSecurityUpdates.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` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryDependabotSecurityUpdates.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryDependabotSecurityUpdates.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryDependabotSecurityUpdates.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a RepositoryDependabotSecurityUpdates resource upon running "cdktn 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 RepositoryDependabotSecurityUpdates to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing RepositoryDependabotSecurityUpdates that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_dependabot_security_updates#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the RepositoryDependabotSecurityUpdates to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| EnabledInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Enabled | bool\|Io.Cdktn.IResolvable | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `EnabledInput`Optional + +```csharp +public bool|IResolvable EnabledInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Enabled`Required + +```csharp +public bool|IResolvable Enabled { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### RepositoryDependabotSecurityUpdatesConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryDependabotSecurityUpdatesConfig { + 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, + bool|IResolvable Enabled, + string Repository, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Enabled | bool\|Io.Cdktn.IResolvable | The state of the automated security fixes. | +| Repository | string | The GitHub repository. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_dependabot_security_updates#id RepositoryDependabotSecurityUpdates#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Enabled`Required + +```csharp +public bool|IResolvable Enabled { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +The state of the automated security fixes. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_dependabot_security_updates#enabled RepositoryDependabotSecurityUpdates#enabled} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_dependabot_security_updates#repository RepositoryDependabotSecurityUpdates#repository} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_dependabot_security_updates#id RepositoryDependabotSecurityUpdates#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. + +--- + + + diff --git a/docs/repositoryDependabotSecurityUpdates.java.md b/docs/repositoryDependabotSecurityUpdates.java.md new file mode 100644 index 000000000..1b7625633 --- /dev/null +++ b/docs/repositoryDependabotSecurityUpdates.java.md @@ -0,0 +1,1001 @@ +# `repositoryDependabotSecurityUpdates` Submodule + +## Constructs + +### RepositoryDependabotSecurityUpdates + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_dependabot_security_updates github_repository_dependabot_security_updates}. + +#### Initializers + +```java +import io.cdktn.providers.github.repository_dependabot_security_updates.RepositoryDependabotSecurityUpdates; + +RepositoryDependabotSecurityUpdates.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .enabled(java.lang.Boolean|IResolvable) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| enabled | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | The state of the automated security fixes. | +| repository | java.lang.String | The GitHub repository. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_dependabot_security_updates#id RepositoryDependabotSecurityUpdates#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `enabled`Required + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +The state of the automated security fixes. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_dependabot_security_updates#enabled RepositoryDependabotSecurityUpdates#enabled} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_dependabot_security_updates#repository RepositoryDependabotSecurityUpdates#repository} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_dependabot_security_updates#id RepositoryDependabotSecurityUpdates#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a RepositoryDependabotSecurityUpdates resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.repository_dependabot_security_updates.RepositoryDependabotSecurityUpdates; + +RepositoryDependabotSecurityUpdates.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` + +```java +import io.cdktn.providers.github.repository_dependabot_security_updates.RepositoryDependabotSecurityUpdates; + +RepositoryDependabotSecurityUpdates.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.repository_dependabot_security_updates.RepositoryDependabotSecurityUpdates; + +RepositoryDependabotSecurityUpdates.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.repository_dependabot_security_updates.RepositoryDependabotSecurityUpdates; + +RepositoryDependabotSecurityUpdates.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),RepositoryDependabotSecurityUpdates.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a RepositoryDependabotSecurityUpdates 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 RepositoryDependabotSecurityUpdates to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing RepositoryDependabotSecurityUpdates that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_dependabot_security_updates#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 RepositoryDependabotSecurityUpdates 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| enabledInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| enabled | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `enabledInput`Optional + +```java +public java.lang.Boolean|IResolvable getEnabledInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `enabled`Required + +```java +public java.lang.Boolean|IResolvable getEnabled(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### RepositoryDependabotSecurityUpdatesConfig + +#### Initializer + +```java +import io.cdktn.providers.github.repository_dependabot_security_updates.RepositoryDependabotSecurityUpdatesConfig; + +RepositoryDependabotSecurityUpdatesConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .enabled(java.lang.Boolean|IResolvable) + .repository(java.lang.String) +// .id(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 | *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 | *No description.* | +| enabled | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | The state of the automated security fixes. | +| repository | java.lang.String | The GitHub repository. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_dependabot_security_updates#id RepositoryDependabotSecurityUpdates#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `enabled`Required + +```java +public java.lang.Boolean|IResolvable getEnabled(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +The state of the automated security fixes. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_dependabot_security_updates#enabled RepositoryDependabotSecurityUpdates#enabled} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_dependabot_security_updates#repository RepositoryDependabotSecurityUpdates#repository} + +--- + +##### `id`Optional + +```java +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/resources/repository_dependabot_security_updates#id RepositoryDependabotSecurityUpdates#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. + +--- + + + diff --git a/docs/repositoryDeployKey.csharp.md b/docs/repositoryDeployKey.csharp.md new file mode 100644 index 000000000..6df331cab --- /dev/null +++ b/docs/repositoryDeployKey.csharp.md @@ -0,0 +1,1006 @@ +# `repositoryDeployKey` Submodule + +## Constructs + +### RepositoryDeployKey + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deploy_key github_repository_deploy_key}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryDeployKey(Construct Scope, string Id, RepositoryDeployKeyConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | RepositoryDeployKeyConfig | *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:* RepositoryDeployKeyConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | +| ResetReadOnly | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetReadOnly` + +```csharp +private void ResetReadOnly() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a RepositoryDeployKey resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryDeployKey.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` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryDeployKey.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryDeployKey.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryDeployKey.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a RepositoryDeployKey resource upon running "cdktn 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 RepositoryDeployKey to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing RepositoryDeployKey that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deploy_key#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the RepositoryDeployKey to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Etag | string | *No description.* | +| IdInput | string | *No description.* | +| KeyInput | string | *No description.* | +| ReadOnlyInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RepositoryInput | string | *No description.* | +| TitleInput | string | *No description.* | +| Id | string | *No description.* | +| Key | string | *No description.* | +| ReadOnly | bool\|Io.Cdktn.IResolvable | *No description.* | +| Repository | string | *No description.* | +| Title | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `KeyInput`Optional + +```csharp +public string KeyInput { get; } +``` + +- *Type:* string + +--- + +##### `ReadOnlyInput`Optional + +```csharp +public bool|IResolvable ReadOnlyInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `TitleInput`Optional + +```csharp +public string TitleInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Key`Required + +```csharp +public string Key { get; } +``` + +- *Type:* string + +--- + +##### `ReadOnly`Required + +```csharp +public bool|IResolvable ReadOnly { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `Title`Required + +```csharp +public string Title { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### RepositoryDeployKeyConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryDeployKeyConfig { + 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 Key, + string Repository, + string Title, + string Id = null, + bool|IResolvable ReadOnly = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Key | string | A SSH key. | +| Repository | string | Name of the GitHub repository. | +| Title | string | A title. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deploy_key#id RepositoryDeployKey#id}. | +| ReadOnly | bool\|Io.Cdktn.IResolvable | A boolean qualifying the key to be either read only or read/write. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Key`Required + +```csharp +public string Key { get; set; } +``` + +- *Type:* string + +A SSH key. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deploy_key#key RepositoryDeployKey#key} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Name of the GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deploy_key#repository RepositoryDeployKey#repository} + +--- + +##### `Title`Required + +```csharp +public string Title { get; set; } +``` + +- *Type:* string + +A title. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deploy_key#title RepositoryDeployKey#title} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deploy_key#id RepositoryDeployKey#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. + +--- + +##### `ReadOnly`Optional + +```csharp +public bool|IResolvable ReadOnly { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +A boolean qualifying the key to be either read only or read/write. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deploy_key#read_only RepositoryDeployKey#read_only} + +--- + + + diff --git a/docs/repositoryDeployKey.java.md b/docs/repositoryDeployKey.java.md new file mode 100644 index 000000000..c9ee4e2f2 --- /dev/null +++ b/docs/repositoryDeployKey.java.md @@ -0,0 +1,1119 @@ +# `repositoryDeployKey` Submodule + +## Constructs + +### RepositoryDeployKey + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deploy_key github_repository_deploy_key}. + +#### Initializers + +```java +import io.cdktn.providers.github.repository_deploy_key.RepositoryDeployKey; + +RepositoryDeployKey.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .key(java.lang.String) + .repository(java.lang.String) + .title(java.lang.String) +// .id(java.lang.String) +// .readOnly(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 | *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 | *No description.* | +| key | java.lang.String | A SSH key. | +| repository | java.lang.String | Name of the GitHub repository. | +| title | java.lang.String | A title. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deploy_key#id RepositoryDeployKey#id}. | +| readOnly | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | A boolean qualifying the key to be either read only or read/write. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `key`Required + +- *Type:* java.lang.String + +A SSH key. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deploy_key#key RepositoryDeployKey#key} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Name of the GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deploy_key#repository RepositoryDeployKey#repository} + +--- + +##### `title`Required + +- *Type:* java.lang.String + +A title. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deploy_key#title RepositoryDeployKey#title} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deploy_key#id RepositoryDeployKey#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. + +--- + +##### `readOnly`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +A boolean qualifying the key to be either read only or read/write. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deploy_key#read_only RepositoryDeployKey#read_only} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | +| resetReadOnly | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetReadOnly` + +```java +public void resetReadOnly() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a RepositoryDeployKey resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.repository_deploy_key.RepositoryDeployKey; + +RepositoryDeployKey.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` + +```java +import io.cdktn.providers.github.repository_deploy_key.RepositoryDeployKey; + +RepositoryDeployKey.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.repository_deploy_key.RepositoryDeployKey; + +RepositoryDeployKey.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.repository_deploy_key.RepositoryDeployKey; + +RepositoryDeployKey.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),RepositoryDeployKey.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a RepositoryDeployKey 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 RepositoryDeployKey to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing RepositoryDeployKey that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deploy_key#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 RepositoryDeployKey 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| etag | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| keyInput | java.lang.String | *No description.* | +| readOnlyInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| titleInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| key | java.lang.String | *No description.* | +| readOnly | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| repository | java.lang.String | *No description.* | +| title | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `keyInput`Optional + +```java +public java.lang.String getKeyInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `readOnlyInput`Optional + +```java +public java.lang.Boolean|IResolvable getReadOnlyInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `titleInput`Optional + +```java +public java.lang.String getTitleInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `key`Required + +```java +public java.lang.String getKey(); +``` + +- *Type:* java.lang.String + +--- + +##### `readOnly`Required + +```java +public java.lang.Boolean|IResolvable getReadOnly(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `title`Required + +```java +public java.lang.String getTitle(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### RepositoryDeployKeyConfig + +#### Initializer + +```java +import io.cdktn.providers.github.repository_deploy_key.RepositoryDeployKeyConfig; + +RepositoryDeployKeyConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .key(java.lang.String) + .repository(java.lang.String) + .title(java.lang.String) +// .id(java.lang.String) +// .readOnly(java.lang.Boolean|IResolvable) + .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 | *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 | *No description.* | +| key | java.lang.String | A SSH key. | +| repository | java.lang.String | Name of the GitHub repository. | +| title | java.lang.String | A title. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deploy_key#id RepositoryDeployKey#id}. | +| readOnly | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | A boolean qualifying the key to be either read only or read/write. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `key`Required + +```java +public java.lang.String getKey(); +``` + +- *Type:* java.lang.String + +A SSH key. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deploy_key#key RepositoryDeployKey#key} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Name of the GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deploy_key#repository RepositoryDeployKey#repository} + +--- + +##### `title`Required + +```java +public java.lang.String getTitle(); +``` + +- *Type:* java.lang.String + +A title. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deploy_key#title RepositoryDeployKey#title} + +--- + +##### `id`Optional + +```java +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/resources/repository_deploy_key#id RepositoryDeployKey#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. + +--- + +##### `readOnly`Optional + +```java +public java.lang.Boolean|IResolvable getReadOnly(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +A boolean qualifying the key to be either read only or read/write. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deploy_key#read_only RepositoryDeployKey#read_only} + +--- + + + diff --git a/docs/repositoryDeploymentBranchPolicy.csharp.md b/docs/repositoryDeploymentBranchPolicy.csharp.md new file mode 100644 index 000000000..0ca8bf9b5 --- /dev/null +++ b/docs/repositoryDeploymentBranchPolicy.csharp.md @@ -0,0 +1,995 @@ +# `repositoryDeploymentBranchPolicy` Submodule + +## Constructs + +### RepositoryDeploymentBranchPolicy + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deployment_branch_policy github_repository_deployment_branch_policy}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryDeploymentBranchPolicy(Construct Scope, string Id, RepositoryDeploymentBranchPolicyConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | RepositoryDeploymentBranchPolicyConfig | *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:* RepositoryDeploymentBranchPolicyConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetEtag | *No description.* | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetEtag` + +```csharp +private void ResetEtag() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a RepositoryDeploymentBranchPolicy resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryDeploymentBranchPolicy.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` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryDeploymentBranchPolicy.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryDeploymentBranchPolicy.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryDeploymentBranchPolicy.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a RepositoryDeploymentBranchPolicy resource upon running "cdktn 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 RepositoryDeploymentBranchPolicy to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing RepositoryDeploymentBranchPolicy that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deployment_branch_policy#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the RepositoryDeploymentBranchPolicy to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| EnvironmentNameInput | string | *No description.* | +| EtagInput | string | *No description.* | +| IdInput | string | *No description.* | +| NameInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| EnvironmentName | string | *No description.* | +| Etag | string | *No description.* | +| Id | string | *No description.* | +| Name | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `EnvironmentNameInput`Optional + +```csharp +public string EnvironmentNameInput { get; } +``` + +- *Type:* string + +--- + +##### `EtagInput`Optional + +```csharp +public string EtagInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `EnvironmentName`Required + +```csharp +public string EnvironmentName { get; } +``` + +- *Type:* string + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### RepositoryDeploymentBranchPolicyConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryDeploymentBranchPolicyConfig { + 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 EnvironmentName, + string Name, + string Repository, + string Etag = null, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| EnvironmentName | string | The target environment name. | +| Name | string | The name of the branch. | +| Repository | string | The GitHub repository name. | +| Etag | string | An etag representing the Branch object. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deployment_branch_policy#id RepositoryDeploymentBranchPolicy#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `EnvironmentName`Required + +```csharp +public string EnvironmentName { get; set; } +``` + +- *Type:* string + +The target environment name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deployment_branch_policy#environment_name RepositoryDeploymentBranchPolicy#environment_name} + +--- + +##### `Name`Required + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +The name of the branch. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deployment_branch_policy#name RepositoryDeploymentBranchPolicy#name} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The GitHub repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deployment_branch_policy#repository RepositoryDeploymentBranchPolicy#repository} + +--- + +##### `Etag`Optional + +```csharp +public string Etag { get; set; } +``` + +- *Type:* string + +An etag representing the Branch object. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deployment_branch_policy#etag RepositoryDeploymentBranchPolicy#etag} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deployment_branch_policy#id RepositoryDeploymentBranchPolicy#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. + +--- + + + diff --git a/docs/repositoryDeploymentBranchPolicy.java.md b/docs/repositoryDeploymentBranchPolicy.java.md new file mode 100644 index 000000000..d14254413 --- /dev/null +++ b/docs/repositoryDeploymentBranchPolicy.java.md @@ -0,0 +1,1108 @@ +# `repositoryDeploymentBranchPolicy` Submodule + +## Constructs + +### RepositoryDeploymentBranchPolicy + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deployment_branch_policy github_repository_deployment_branch_policy}. + +#### Initializers + +```java +import io.cdktn.providers.github.repository_deployment_branch_policy.RepositoryDeploymentBranchPolicy; + +RepositoryDeploymentBranchPolicy.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .environmentName(java.lang.String) + .name(java.lang.String) + .repository(java.lang.String) +// .etag(java.lang.String) +// .id(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 | *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 | *No description.* | +| environmentName | java.lang.String | The target environment name. | +| name | java.lang.String | The name of the branch. | +| repository | java.lang.String | The GitHub repository name. | +| etag | java.lang.String | An etag representing the Branch object. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deployment_branch_policy#id RepositoryDeploymentBranchPolicy#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `environmentName`Required + +- *Type:* java.lang.String + +The target environment name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deployment_branch_policy#environment_name RepositoryDeploymentBranchPolicy#environment_name} + +--- + +##### `name`Required + +- *Type:* java.lang.String + +The name of the branch. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deployment_branch_policy#name RepositoryDeploymentBranchPolicy#name} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The GitHub repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deployment_branch_policy#repository RepositoryDeploymentBranchPolicy#repository} + +--- + +##### `etag`Optional + +- *Type:* java.lang.String + +An etag representing the Branch object. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deployment_branch_policy#etag RepositoryDeploymentBranchPolicy#etag} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deployment_branch_policy#id RepositoryDeploymentBranchPolicy#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetEtag | *No description.* | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetEtag` + +```java +public void resetEtag() +``` + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a RepositoryDeploymentBranchPolicy resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.repository_deployment_branch_policy.RepositoryDeploymentBranchPolicy; + +RepositoryDeploymentBranchPolicy.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` + +```java +import io.cdktn.providers.github.repository_deployment_branch_policy.RepositoryDeploymentBranchPolicy; + +RepositoryDeploymentBranchPolicy.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.repository_deployment_branch_policy.RepositoryDeploymentBranchPolicy; + +RepositoryDeploymentBranchPolicy.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.repository_deployment_branch_policy.RepositoryDeploymentBranchPolicy; + +RepositoryDeploymentBranchPolicy.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),RepositoryDeploymentBranchPolicy.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a RepositoryDeploymentBranchPolicy 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 RepositoryDeploymentBranchPolicy to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing RepositoryDeploymentBranchPolicy that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deployment_branch_policy#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 RepositoryDeploymentBranchPolicy 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| environmentNameInput | java.lang.String | *No description.* | +| etagInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| environmentName | java.lang.String | *No description.* | +| etag | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `environmentNameInput`Optional + +```java +public java.lang.String getEnvironmentNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `etagInput`Optional + +```java +public java.lang.String getEtagInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `environmentName`Required + +```java +public java.lang.String getEnvironmentName(); +``` + +- *Type:* java.lang.String + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### RepositoryDeploymentBranchPolicyConfig + +#### Initializer + +```java +import io.cdktn.providers.github.repository_deployment_branch_policy.RepositoryDeploymentBranchPolicyConfig; + +RepositoryDeploymentBranchPolicyConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .environmentName(java.lang.String) + .name(java.lang.String) + .repository(java.lang.String) +// .etag(java.lang.String) +// .id(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 | *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 | *No description.* | +| environmentName | java.lang.String | The target environment name. | +| name | java.lang.String | The name of the branch. | +| repository | java.lang.String | The GitHub repository name. | +| etag | java.lang.String | An etag representing the Branch object. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deployment_branch_policy#id RepositoryDeploymentBranchPolicy#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `environmentName`Required + +```java +public java.lang.String getEnvironmentName(); +``` + +- *Type:* java.lang.String + +The target environment name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deployment_branch_policy#environment_name RepositoryDeploymentBranchPolicy#environment_name} + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +The name of the branch. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deployment_branch_policy#name RepositoryDeploymentBranchPolicy#name} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The GitHub repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deployment_branch_policy#repository RepositoryDeploymentBranchPolicy#repository} + +--- + +##### `etag`Optional + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +An etag representing the Branch object. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_deployment_branch_policy#etag RepositoryDeploymentBranchPolicy#etag} + +--- + +##### `id`Optional + +```java +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/resources/repository_deployment_branch_policy#id RepositoryDeploymentBranchPolicy#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. + +--- + + + diff --git a/docs/repositoryEnvironment.csharp.md b/docs/repositoryEnvironment.csharp.md new file mode 100644 index 000000000..f2d2013f4 --- /dev/null +++ b/docs/repositoryEnvironment.csharp.md @@ -0,0 +1,1879 @@ +# `repositoryEnvironment` Submodule + +## Constructs + +### RepositoryEnvironment + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment github_repository_environment}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryEnvironment(Construct Scope, string Id, RepositoryEnvironmentConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | RepositoryEnvironmentConfig | *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:* RepositoryEnvironmentConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| PutDeploymentBranchPolicy | *No description.* | +| PutReviewers | *No description.* | +| ResetCanAdminsBypass | *No description.* | +| ResetDeploymentBranchPolicy | *No description.* | +| ResetId | *No description.* | +| ResetPreventSelfReview | *No description.* | +| ResetReviewers | *No description.* | +| ResetWaitTimer | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `PutDeploymentBranchPolicy` + +```csharp +private void PutDeploymentBranchPolicy(RepositoryEnvironmentDeploymentBranchPolicy Value) +``` + +###### `Value`Required + +- *Type:* RepositoryEnvironmentDeploymentBranchPolicy + +--- + +##### `PutReviewers` + +```csharp +private void PutReviewers(RepositoryEnvironmentReviewers Value) +``` + +###### `Value`Required + +- *Type:* RepositoryEnvironmentReviewers + +--- + +##### `ResetCanAdminsBypass` + +```csharp +private void ResetCanAdminsBypass() +``` + +##### `ResetDeploymentBranchPolicy` + +```csharp +private void ResetDeploymentBranchPolicy() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetPreventSelfReview` + +```csharp +private void ResetPreventSelfReview() +``` + +##### `ResetReviewers` + +```csharp +private void ResetReviewers() +``` + +##### `ResetWaitTimer` + +```csharp +private void ResetWaitTimer() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a RepositoryEnvironment resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryEnvironment.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` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryEnvironment.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryEnvironment.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryEnvironment.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a RepositoryEnvironment resource upon running "cdktn 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 RepositoryEnvironment to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing RepositoryEnvironment that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the RepositoryEnvironment to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| DeploymentBranchPolicy | RepositoryEnvironmentDeploymentBranchPolicyOutputReference | *No description.* | +| RepositoryId | double | *No description.* | +| Reviewers | RepositoryEnvironmentReviewersOutputReference | *No description.* | +| CanAdminsBypassInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| DeploymentBranchPolicyInput | RepositoryEnvironmentDeploymentBranchPolicy | *No description.* | +| EnvironmentInput | string | *No description.* | +| IdInput | string | *No description.* | +| PreventSelfReviewInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RepositoryInput | string | *No description.* | +| ReviewersInput | RepositoryEnvironmentReviewers | *No description.* | +| WaitTimerInput | double | *No description.* | +| CanAdminsBypass | bool\|Io.Cdktn.IResolvable | *No description.* | +| Environment | string | *No description.* | +| Id | string | *No description.* | +| PreventSelfReview | bool\|Io.Cdktn.IResolvable | *No description.* | +| Repository | string | *No description.* | +| WaitTimer | double | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `DeploymentBranchPolicy`Required + +```csharp +public RepositoryEnvironmentDeploymentBranchPolicyOutputReference DeploymentBranchPolicy { get; } +``` + +- *Type:* RepositoryEnvironmentDeploymentBranchPolicyOutputReference + +--- + +##### `RepositoryId`Required + +```csharp +public double RepositoryId { get; } +``` + +- *Type:* double + +--- + +##### `Reviewers`Required + +```csharp +public RepositoryEnvironmentReviewersOutputReference Reviewers { get; } +``` + +- *Type:* RepositoryEnvironmentReviewersOutputReference + +--- + +##### `CanAdminsBypassInput`Optional + +```csharp +public bool|IResolvable CanAdminsBypassInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `DeploymentBranchPolicyInput`Optional + +```csharp +public RepositoryEnvironmentDeploymentBranchPolicy DeploymentBranchPolicyInput { get; } +``` + +- *Type:* RepositoryEnvironmentDeploymentBranchPolicy + +--- + +##### `EnvironmentInput`Optional + +```csharp +public string EnvironmentInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `PreventSelfReviewInput`Optional + +```csharp +public bool|IResolvable PreventSelfReviewInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `ReviewersInput`Optional + +```csharp +public RepositoryEnvironmentReviewers ReviewersInput { get; } +``` + +- *Type:* RepositoryEnvironmentReviewers + +--- + +##### `WaitTimerInput`Optional + +```csharp +public double WaitTimerInput { get; } +``` + +- *Type:* double + +--- + +##### `CanAdminsBypass`Required + +```csharp +public bool|IResolvable CanAdminsBypass { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Environment`Required + +```csharp +public string Environment { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `PreventSelfReview`Required + +```csharp +public bool|IResolvable PreventSelfReview { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `WaitTimer`Required + +```csharp +public double WaitTimer { get; } +``` + +- *Type:* double + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### RepositoryEnvironmentConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryEnvironmentConfig { + 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 Environment, + string Repository, + bool|IResolvable CanAdminsBypass = null, + RepositoryEnvironmentDeploymentBranchPolicy DeploymentBranchPolicy = null, + string Id = null, + bool|IResolvable PreventSelfReview = null, + RepositoryEnvironmentReviewers Reviewers = null, + double WaitTimer = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Environment | string | The name of the environment. | +| Repository | string | The repository of the environment. | +| CanAdminsBypass | bool\|Io.Cdktn.IResolvable | Can Admins bypass deployment protections. | +| DeploymentBranchPolicy | RepositoryEnvironmentDeploymentBranchPolicy | deployment_branch_policy block. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#id RepositoryEnvironment#id}. | +| PreventSelfReview | bool\|Io.Cdktn.IResolvable | Prevent users from approving workflows runs that they triggered. | +| Reviewers | RepositoryEnvironmentReviewers | reviewers block. | +| WaitTimer | double | Amount of time to delay a job after the job is initially triggered. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Environment`Required + +```csharp +public string Environment { get; set; } +``` + +- *Type:* string + +The name of the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#environment RepositoryEnvironment#environment} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The repository of the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#repository RepositoryEnvironment#repository} + +--- + +##### `CanAdminsBypass`Optional + +```csharp +public bool|IResolvable CanAdminsBypass { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Can Admins bypass deployment protections. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#can_admins_bypass RepositoryEnvironment#can_admins_bypass} + +--- + +##### `DeploymentBranchPolicy`Optional + +```csharp +public RepositoryEnvironmentDeploymentBranchPolicy DeploymentBranchPolicy { get; set; } +``` + +- *Type:* RepositoryEnvironmentDeploymentBranchPolicy + +deployment_branch_policy block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#deployment_branch_policy RepositoryEnvironment#deployment_branch_policy} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#id RepositoryEnvironment#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. + +--- + +##### `PreventSelfReview`Optional + +```csharp +public bool|IResolvable PreventSelfReview { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Prevent users from approving workflows runs that they triggered. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#prevent_self_review RepositoryEnvironment#prevent_self_review} + +--- + +##### `Reviewers`Optional + +```csharp +public RepositoryEnvironmentReviewers Reviewers { get; set; } +``` + +- *Type:* RepositoryEnvironmentReviewers + +reviewers block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#reviewers RepositoryEnvironment#reviewers} + +--- + +##### `WaitTimer`Optional + +```csharp +public double WaitTimer { get; set; } +``` + +- *Type:* double + +Amount of time to delay a job after the job is initially triggered. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#wait_timer RepositoryEnvironment#wait_timer} + +--- + +### RepositoryEnvironmentDeploymentBranchPolicy + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryEnvironmentDeploymentBranchPolicy { + bool|IResolvable CustomBranchPolicies, + bool|IResolvable ProtectedBranches +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CustomBranchPolicies | bool\|Io.Cdktn.IResolvable | Whether only branches that match the specified name patterns can deploy to this environment. | +| ProtectedBranches | bool\|Io.Cdktn.IResolvable | Whether only branches with branch protection rules can deploy to this environment. | + +--- + +##### `CustomBranchPolicies`Required + +```csharp +public bool|IResolvable CustomBranchPolicies { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether only branches that match the specified name patterns can deploy to this environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#custom_branch_policies RepositoryEnvironment#custom_branch_policies} + +--- + +##### `ProtectedBranches`Required + +```csharp +public bool|IResolvable ProtectedBranches { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether only branches with branch protection rules can deploy to this environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#protected_branches RepositoryEnvironment#protected_branches} + +--- + +### RepositoryEnvironmentReviewers + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryEnvironmentReviewers { + double[] Teams = null, + double[] Users = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Teams | double[] | Up to 6 IDs for teams who may review jobs that reference the environment. | +| Users | double[] | Up to 6 IDs for users who may review jobs that reference the environment. | + +--- + +##### `Teams`Optional + +```csharp +public double[] Teams { get; set; } +``` + +- *Type:* double[] + +Up to 6 IDs for teams who may review jobs that reference the environment. + +Reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#teams RepositoryEnvironment#teams} + +--- + +##### `Users`Optional + +```csharp +public double[] Users { get; set; } +``` + +- *Type:* double[] + +Up to 6 IDs for users who may review jobs that reference the environment. + +Reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#users RepositoryEnvironment#users} + +--- + +## Classes + +### RepositoryEnvironmentDeploymentBranchPolicyOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryEnvironmentDeploymentBranchPolicyOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| CustomBranchPoliciesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| ProtectedBranchesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| CustomBranchPolicies | bool\|Io.Cdktn.IResolvable | *No description.* | +| ProtectedBranches | bool\|Io.Cdktn.IResolvable | *No description.* | +| InternalValue | RepositoryEnvironmentDeploymentBranchPolicy | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `CustomBranchPoliciesInput`Optional + +```csharp +public bool|IResolvable CustomBranchPoliciesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ProtectedBranchesInput`Optional + +```csharp +public bool|IResolvable ProtectedBranchesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `CustomBranchPolicies`Required + +```csharp +public bool|IResolvable CustomBranchPolicies { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ProtectedBranches`Required + +```csharp +public bool|IResolvable ProtectedBranches { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryEnvironmentDeploymentBranchPolicy InternalValue { get; } +``` + +- *Type:* RepositoryEnvironmentDeploymentBranchPolicy + +--- + + +### RepositoryEnvironmentReviewersOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryEnvironmentReviewersOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetTeams | *No description.* | +| ResetUsers | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetTeams` + +```csharp +private void ResetTeams() +``` + +##### `ResetUsers` + +```csharp +private void ResetUsers() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| TeamsInput | double[] | *No description.* | +| UsersInput | double[] | *No description.* | +| Teams | double[] | *No description.* | +| Users | double[] | *No description.* | +| InternalValue | RepositoryEnvironmentReviewers | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `TeamsInput`Optional + +```csharp +public double[] TeamsInput { get; } +``` + +- *Type:* double[] + +--- + +##### `UsersInput`Optional + +```csharp +public double[] UsersInput { get; } +``` + +- *Type:* double[] + +--- + +##### `Teams`Required + +```csharp +public double[] Teams { get; } +``` + +- *Type:* double[] + +--- + +##### `Users`Required + +```csharp +public double[] Users { get; } +``` + +- *Type:* double[] + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryEnvironmentReviewers InternalValue { get; } +``` + +- *Type:* RepositoryEnvironmentReviewers + +--- + + + diff --git a/docs/repositoryEnvironment.java.md b/docs/repositoryEnvironment.java.md new file mode 100644 index 000000000..6d0ae3a1c --- /dev/null +++ b/docs/repositoryEnvironment.java.md @@ -0,0 +1,2028 @@ +# `repositoryEnvironment` Submodule + +## Constructs + +### RepositoryEnvironment + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment github_repository_environment}. + +#### Initializers + +```java +import io.cdktn.providers.github.repository_environment.RepositoryEnvironment; + +RepositoryEnvironment.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .environment(java.lang.String) + .repository(java.lang.String) +// .canAdminsBypass(java.lang.Boolean|IResolvable) +// .deploymentBranchPolicy(RepositoryEnvironmentDeploymentBranchPolicy) +// .id(java.lang.String) +// .preventSelfReview(java.lang.Boolean|IResolvable) +// .reviewers(RepositoryEnvironmentReviewers) +// .waitTimer(java.lang.Number) + .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 | *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 | *No description.* | +| environment | java.lang.String | The name of the environment. | +| repository | java.lang.String | The repository of the environment. | +| canAdminsBypass | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Can Admins bypass deployment protections. | +| deploymentBranchPolicy | RepositoryEnvironmentDeploymentBranchPolicy | deployment_branch_policy block. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#id RepositoryEnvironment#id}. | +| preventSelfReview | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Prevent users from approving workflows runs that they triggered. | +| reviewers | RepositoryEnvironmentReviewers | reviewers block. | +| waitTimer | java.lang.Number | Amount of time to delay a job after the job is initially triggered. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `environment`Required + +- *Type:* java.lang.String + +The name of the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#environment RepositoryEnvironment#environment} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The repository of the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#repository RepositoryEnvironment#repository} + +--- + +##### `canAdminsBypass`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Can Admins bypass deployment protections. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#can_admins_bypass RepositoryEnvironment#can_admins_bypass} + +--- + +##### `deploymentBranchPolicy`Optional + +- *Type:* RepositoryEnvironmentDeploymentBranchPolicy + +deployment_branch_policy block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#deployment_branch_policy RepositoryEnvironment#deployment_branch_policy} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#id RepositoryEnvironment#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. + +--- + +##### `preventSelfReview`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Prevent users from approving workflows runs that they triggered. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#prevent_self_review RepositoryEnvironment#prevent_self_review} + +--- + +##### `reviewers`Optional + +- *Type:* RepositoryEnvironmentReviewers + +reviewers block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#reviewers RepositoryEnvironment#reviewers} + +--- + +##### `waitTimer`Optional + +- *Type:* java.lang.Number + +Amount of time to delay a job after the job is initially triggered. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#wait_timer RepositoryEnvironment#wait_timer} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| putDeploymentBranchPolicy | *No description.* | +| putReviewers | *No description.* | +| resetCanAdminsBypass | *No description.* | +| resetDeploymentBranchPolicy | *No description.* | +| resetId | *No description.* | +| resetPreventSelfReview | *No description.* | +| resetReviewers | *No description.* | +| resetWaitTimer | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `putDeploymentBranchPolicy` + +```java +public void putDeploymentBranchPolicy(RepositoryEnvironmentDeploymentBranchPolicy value) +``` + +###### `value`Required + +- *Type:* RepositoryEnvironmentDeploymentBranchPolicy + +--- + +##### `putReviewers` + +```java +public void putReviewers(RepositoryEnvironmentReviewers value) +``` + +###### `value`Required + +- *Type:* RepositoryEnvironmentReviewers + +--- + +##### `resetCanAdminsBypass` + +```java +public void resetCanAdminsBypass() +``` + +##### `resetDeploymentBranchPolicy` + +```java +public void resetDeploymentBranchPolicy() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetPreventSelfReview` + +```java +public void resetPreventSelfReview() +``` + +##### `resetReviewers` + +```java +public void resetReviewers() +``` + +##### `resetWaitTimer` + +```java +public void resetWaitTimer() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a RepositoryEnvironment resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.repository_environment.RepositoryEnvironment; + +RepositoryEnvironment.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` + +```java +import io.cdktn.providers.github.repository_environment.RepositoryEnvironment; + +RepositoryEnvironment.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.repository_environment.RepositoryEnvironment; + +RepositoryEnvironment.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.repository_environment.RepositoryEnvironment; + +RepositoryEnvironment.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),RepositoryEnvironment.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a RepositoryEnvironment 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 RepositoryEnvironment to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing RepositoryEnvironment that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#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 RepositoryEnvironment 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| deploymentBranchPolicy | RepositoryEnvironmentDeploymentBranchPolicyOutputReference | *No description.* | +| repositoryId | java.lang.Number | *No description.* | +| reviewers | RepositoryEnvironmentReviewersOutputReference | *No description.* | +| canAdminsBypassInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| deploymentBranchPolicyInput | RepositoryEnvironmentDeploymentBranchPolicy | *No description.* | +| environmentInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| preventSelfReviewInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| reviewersInput | RepositoryEnvironmentReviewers | *No description.* | +| waitTimerInput | java.lang.Number | *No description.* | +| canAdminsBypass | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| environment | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| preventSelfReview | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| repository | java.lang.String | *No description.* | +| waitTimer | java.lang.Number | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `deploymentBranchPolicy`Required + +```java +public RepositoryEnvironmentDeploymentBranchPolicyOutputReference getDeploymentBranchPolicy(); +``` + +- *Type:* RepositoryEnvironmentDeploymentBranchPolicyOutputReference + +--- + +##### `repositoryId`Required + +```java +public java.lang.Number getRepositoryId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `reviewers`Required + +```java +public RepositoryEnvironmentReviewersOutputReference getReviewers(); +``` + +- *Type:* RepositoryEnvironmentReviewersOutputReference + +--- + +##### `canAdminsBypassInput`Optional + +```java +public java.lang.Boolean|IResolvable getCanAdminsBypassInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `deploymentBranchPolicyInput`Optional + +```java +public RepositoryEnvironmentDeploymentBranchPolicy getDeploymentBranchPolicyInput(); +``` + +- *Type:* RepositoryEnvironmentDeploymentBranchPolicy + +--- + +##### `environmentInput`Optional + +```java +public java.lang.String getEnvironmentInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `preventSelfReviewInput`Optional + +```java +public java.lang.Boolean|IResolvable getPreventSelfReviewInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `reviewersInput`Optional + +```java +public RepositoryEnvironmentReviewers getReviewersInput(); +``` + +- *Type:* RepositoryEnvironmentReviewers + +--- + +##### `waitTimerInput`Optional + +```java +public java.lang.Number getWaitTimerInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `canAdminsBypass`Required + +```java +public java.lang.Boolean|IResolvable getCanAdminsBypass(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `environment`Required + +```java +public java.lang.String getEnvironment(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `preventSelfReview`Required + +```java +public java.lang.Boolean|IResolvable getPreventSelfReview(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `waitTimer`Required + +```java +public java.lang.Number getWaitTimer(); +``` + +- *Type:* java.lang.Number + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### RepositoryEnvironmentConfig + +#### Initializer + +```java +import io.cdktn.providers.github.repository_environment.RepositoryEnvironmentConfig; + +RepositoryEnvironmentConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .environment(java.lang.String) + .repository(java.lang.String) +// .canAdminsBypass(java.lang.Boolean|IResolvable) +// .deploymentBranchPolicy(RepositoryEnvironmentDeploymentBranchPolicy) +// .id(java.lang.String) +// .preventSelfReview(java.lang.Boolean|IResolvable) +// .reviewers(RepositoryEnvironmentReviewers) +// .waitTimer(java.lang.Number) + .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 | *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 | *No description.* | +| environment | java.lang.String | The name of the environment. | +| repository | java.lang.String | The repository of the environment. | +| canAdminsBypass | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Can Admins bypass deployment protections. | +| deploymentBranchPolicy | RepositoryEnvironmentDeploymentBranchPolicy | deployment_branch_policy block. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#id RepositoryEnvironment#id}. | +| preventSelfReview | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Prevent users from approving workflows runs that they triggered. | +| reviewers | RepositoryEnvironmentReviewers | reviewers block. | +| waitTimer | java.lang.Number | Amount of time to delay a job after the job is initially triggered. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `environment`Required + +```java +public java.lang.String getEnvironment(); +``` + +- *Type:* java.lang.String + +The name of the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#environment RepositoryEnvironment#environment} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The repository of the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#repository RepositoryEnvironment#repository} + +--- + +##### `canAdminsBypass`Optional + +```java +public java.lang.Boolean|IResolvable getCanAdminsBypass(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Can Admins bypass deployment protections. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#can_admins_bypass RepositoryEnvironment#can_admins_bypass} + +--- + +##### `deploymentBranchPolicy`Optional + +```java +public RepositoryEnvironmentDeploymentBranchPolicy getDeploymentBranchPolicy(); +``` + +- *Type:* RepositoryEnvironmentDeploymentBranchPolicy + +deployment_branch_policy block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#deployment_branch_policy RepositoryEnvironment#deployment_branch_policy} + +--- + +##### `id`Optional + +```java +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/resources/repository_environment#id RepositoryEnvironment#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. + +--- + +##### `preventSelfReview`Optional + +```java +public java.lang.Boolean|IResolvable getPreventSelfReview(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Prevent users from approving workflows runs that they triggered. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#prevent_self_review RepositoryEnvironment#prevent_self_review} + +--- + +##### `reviewers`Optional + +```java +public RepositoryEnvironmentReviewers getReviewers(); +``` + +- *Type:* RepositoryEnvironmentReviewers + +reviewers block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#reviewers RepositoryEnvironment#reviewers} + +--- + +##### `waitTimer`Optional + +```java +public java.lang.Number getWaitTimer(); +``` + +- *Type:* java.lang.Number + +Amount of time to delay a job after the job is initially triggered. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#wait_timer RepositoryEnvironment#wait_timer} + +--- + +### RepositoryEnvironmentDeploymentBranchPolicy + +#### Initializer + +```java +import io.cdktn.providers.github.repository_environment.RepositoryEnvironmentDeploymentBranchPolicy; + +RepositoryEnvironmentDeploymentBranchPolicy.builder() + .customBranchPolicies(java.lang.Boolean|IResolvable) + .protectedBranches(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| customBranchPolicies | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether only branches that match the specified name patterns can deploy to this environment. | +| protectedBranches | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether only branches with branch protection rules can deploy to this environment. | + +--- + +##### `customBranchPolicies`Required + +```java +public java.lang.Boolean|IResolvable getCustomBranchPolicies(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether only branches that match the specified name patterns can deploy to this environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#custom_branch_policies RepositoryEnvironment#custom_branch_policies} + +--- + +##### `protectedBranches`Required + +```java +public java.lang.Boolean|IResolvable getProtectedBranches(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether only branches with branch protection rules can deploy to this environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#protected_branches RepositoryEnvironment#protected_branches} + +--- + +### RepositoryEnvironmentReviewers + +#### Initializer + +```java +import io.cdktn.providers.github.repository_environment.RepositoryEnvironmentReviewers; + +RepositoryEnvironmentReviewers.builder() +// .teams(java.util.List) +// .users(java.util.List) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| teams | java.util.List | Up to 6 IDs for teams who may review jobs that reference the environment. | +| users | java.util.List | Up to 6 IDs for users who may review jobs that reference the environment. | + +--- + +##### `teams`Optional + +```java +public java.util.List getTeams(); +``` + +- *Type:* java.util.List + +Up to 6 IDs for teams who may review jobs that reference the environment. + +Reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#teams RepositoryEnvironment#teams} + +--- + +##### `users`Optional + +```java +public java.util.List getUsers(); +``` + +- *Type:* java.util.List + +Up to 6 IDs for users who may review jobs that reference the environment. + +Reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment#users RepositoryEnvironment#users} + +--- + +## Classes + +### RepositoryEnvironmentDeploymentBranchPolicyOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_environment.RepositoryEnvironmentDeploymentBranchPolicyOutputReference; + +new RepositoryEnvironmentDeploymentBranchPolicyOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| customBranchPoliciesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| protectedBranchesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| customBranchPolicies | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| protectedBranches | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| internalValue | RepositoryEnvironmentDeploymentBranchPolicy | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `customBranchPoliciesInput`Optional + +```java +public java.lang.Boolean|IResolvable getCustomBranchPoliciesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `protectedBranchesInput`Optional + +```java +public java.lang.Boolean|IResolvable getProtectedBranchesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `customBranchPolicies`Required + +```java +public java.lang.Boolean|IResolvable getCustomBranchPolicies(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `protectedBranches`Required + +```java +public java.lang.Boolean|IResolvable getProtectedBranches(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `internalValue`Optional + +```java +public RepositoryEnvironmentDeploymentBranchPolicy getInternalValue(); +``` + +- *Type:* RepositoryEnvironmentDeploymentBranchPolicy + +--- + + +### RepositoryEnvironmentReviewersOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_environment.RepositoryEnvironmentReviewersOutputReference; + +new RepositoryEnvironmentReviewersOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetTeams | *No description.* | +| resetUsers | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetTeams` + +```java +public void resetTeams() +``` + +##### `resetUsers` + +```java +public void resetUsers() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| teamsInput | java.util.List | *No description.* | +| usersInput | java.util.List | *No description.* | +| teams | java.util.List | *No description.* | +| users | java.util.List | *No description.* | +| internalValue | RepositoryEnvironmentReviewers | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `teamsInput`Optional + +```java +public java.util.List getTeamsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `usersInput`Optional + +```java +public java.util.List getUsersInput(); +``` + +- *Type:* java.util.List + +--- + +##### `teams`Required + +```java +public java.util.List getTeams(); +``` + +- *Type:* java.util.List + +--- + +##### `users`Required + +```java +public java.util.List getUsers(); +``` + +- *Type:* java.util.List + +--- + +##### `internalValue`Optional + +```java +public RepositoryEnvironmentReviewers getInternalValue(); +``` + +- *Type:* RepositoryEnvironmentReviewers + +--- + + + diff --git a/docs/repositoryEnvironmentDeploymentPolicy.csharp.md b/docs/repositoryEnvironmentDeploymentPolicy.csharp.md new file mode 100644 index 000000000..c4b896900 --- /dev/null +++ b/docs/repositoryEnvironmentDeploymentPolicy.csharp.md @@ -0,0 +1,1024 @@ +# `repositoryEnvironmentDeploymentPolicy` Submodule + +## Constructs + +### RepositoryEnvironmentDeploymentPolicy + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment_deployment_policy github_repository_environment_deployment_policy}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryEnvironmentDeploymentPolicy(Construct Scope, string Id, RepositoryEnvironmentDeploymentPolicyConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | RepositoryEnvironmentDeploymentPolicyConfig | *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:* RepositoryEnvironmentDeploymentPolicyConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetBranchPattern | *No description.* | +| ResetId | *No description.* | +| ResetTagPattern | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetBranchPattern` + +```csharp +private void ResetBranchPattern() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetTagPattern` + +```csharp +private void ResetTagPattern() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a RepositoryEnvironmentDeploymentPolicy resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryEnvironmentDeploymentPolicy.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` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryEnvironmentDeploymentPolicy.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryEnvironmentDeploymentPolicy.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryEnvironmentDeploymentPolicy.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a RepositoryEnvironmentDeploymentPolicy resource upon running "cdktn 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 RepositoryEnvironmentDeploymentPolicy to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing RepositoryEnvironmentDeploymentPolicy that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment_deployment_policy#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the RepositoryEnvironmentDeploymentPolicy to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| PolicyId | double | *No description.* | +| RepositoryId | double | *No description.* | +| BranchPatternInput | string | *No description.* | +| EnvironmentInput | string | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| TagPatternInput | string | *No description.* | +| BranchPattern | string | *No description.* | +| Environment | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | +| TagPattern | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `PolicyId`Required + +```csharp +public double PolicyId { get; } +``` + +- *Type:* double + +--- + +##### `RepositoryId`Required + +```csharp +public double RepositoryId { get; } +``` + +- *Type:* double + +--- + +##### `BranchPatternInput`Optional + +```csharp +public string BranchPatternInput { get; } +``` + +- *Type:* string + +--- + +##### `EnvironmentInput`Optional + +```csharp +public string EnvironmentInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `TagPatternInput`Optional + +```csharp +public string TagPatternInput { get; } +``` + +- *Type:* string + +--- + +##### `BranchPattern`Required + +```csharp +public string BranchPattern { get; } +``` + +- *Type:* string + +--- + +##### `Environment`Required + +```csharp +public string Environment { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `TagPattern`Required + +```csharp +public string TagPattern { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### RepositoryEnvironmentDeploymentPolicyConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryEnvironmentDeploymentPolicyConfig { + 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 Environment, + string Repository, + string BranchPattern = null, + string Id = null, + string TagPattern = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Environment | string | The name of the environment. | +| Repository | string | The name of the GitHub repository. | +| BranchPattern | string | The name pattern that branches must match in order to deploy to the environment. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment_deployment_policy#id RepositoryEnvironmentDeploymentPolicy#id}. | +| TagPattern | string | The name pattern that tags must match in order to deploy to the environment. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Environment`Required + +```csharp +public string Environment { get; set; } +``` + +- *Type:* string + +The name of the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment_deployment_policy#environment RepositoryEnvironmentDeploymentPolicy#environment} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The name of the GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment_deployment_policy#repository RepositoryEnvironmentDeploymentPolicy#repository} + +--- + +##### `BranchPattern`Optional + +```csharp +public string BranchPattern { get; set; } +``` + +- *Type:* string + +The name pattern that branches must match in order to deploy to the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment_deployment_policy#branch_pattern RepositoryEnvironmentDeploymentPolicy#branch_pattern} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment_deployment_policy#id RepositoryEnvironmentDeploymentPolicy#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. + +--- + +##### `TagPattern`Optional + +```csharp +public string TagPattern { get; set; } +``` + +- *Type:* string + +The name pattern that tags must match in order to deploy to the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment_deployment_policy#tag_pattern RepositoryEnvironmentDeploymentPolicy#tag_pattern} + +--- + + + diff --git a/docs/repositoryEnvironmentDeploymentPolicy.java.md b/docs/repositoryEnvironmentDeploymentPolicy.java.md new file mode 100644 index 000000000..845eb6af8 --- /dev/null +++ b/docs/repositoryEnvironmentDeploymentPolicy.java.md @@ -0,0 +1,1137 @@ +# `repositoryEnvironmentDeploymentPolicy` Submodule + +## Constructs + +### RepositoryEnvironmentDeploymentPolicy + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment_deployment_policy github_repository_environment_deployment_policy}. + +#### Initializers + +```java +import io.cdktn.providers.github.repository_environment_deployment_policy.RepositoryEnvironmentDeploymentPolicy; + +RepositoryEnvironmentDeploymentPolicy.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .environment(java.lang.String) + .repository(java.lang.String) +// .branchPattern(java.lang.String) +// .id(java.lang.String) +// .tagPattern(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 | *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 | *No description.* | +| environment | java.lang.String | The name of the environment. | +| repository | java.lang.String | The name of the GitHub repository. | +| branchPattern | java.lang.String | The name pattern that branches must match in order to deploy to the environment. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment_deployment_policy#id RepositoryEnvironmentDeploymentPolicy#id}. | +| tagPattern | java.lang.String | The name pattern that tags must match in order to deploy to the environment. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `environment`Required + +- *Type:* java.lang.String + +The name of the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment_deployment_policy#environment RepositoryEnvironmentDeploymentPolicy#environment} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The name of the GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment_deployment_policy#repository RepositoryEnvironmentDeploymentPolicy#repository} + +--- + +##### `branchPattern`Optional + +- *Type:* java.lang.String + +The name pattern that branches must match in order to deploy to the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment_deployment_policy#branch_pattern RepositoryEnvironmentDeploymentPolicy#branch_pattern} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment_deployment_policy#id RepositoryEnvironmentDeploymentPolicy#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. + +--- + +##### `tagPattern`Optional + +- *Type:* java.lang.String + +The name pattern that tags must match in order to deploy to the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment_deployment_policy#tag_pattern RepositoryEnvironmentDeploymentPolicy#tag_pattern} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetBranchPattern | *No description.* | +| resetId | *No description.* | +| resetTagPattern | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetBranchPattern` + +```java +public void resetBranchPattern() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetTagPattern` + +```java +public void resetTagPattern() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a RepositoryEnvironmentDeploymentPolicy resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.repository_environment_deployment_policy.RepositoryEnvironmentDeploymentPolicy; + +RepositoryEnvironmentDeploymentPolicy.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` + +```java +import io.cdktn.providers.github.repository_environment_deployment_policy.RepositoryEnvironmentDeploymentPolicy; + +RepositoryEnvironmentDeploymentPolicy.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.repository_environment_deployment_policy.RepositoryEnvironmentDeploymentPolicy; + +RepositoryEnvironmentDeploymentPolicy.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.repository_environment_deployment_policy.RepositoryEnvironmentDeploymentPolicy; + +RepositoryEnvironmentDeploymentPolicy.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),RepositoryEnvironmentDeploymentPolicy.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a RepositoryEnvironmentDeploymentPolicy 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 RepositoryEnvironmentDeploymentPolicy to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing RepositoryEnvironmentDeploymentPolicy that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment_deployment_policy#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 RepositoryEnvironmentDeploymentPolicy 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| policyId | java.lang.Number | *No description.* | +| repositoryId | java.lang.Number | *No description.* | +| branchPatternInput | java.lang.String | *No description.* | +| environmentInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| tagPatternInput | java.lang.String | *No description.* | +| branchPattern | java.lang.String | *No description.* | +| environment | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | +| tagPattern | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `policyId`Required + +```java +public java.lang.Number getPolicyId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `repositoryId`Required + +```java +public java.lang.Number getRepositoryId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `branchPatternInput`Optional + +```java +public java.lang.String getBranchPatternInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `environmentInput`Optional + +```java +public java.lang.String getEnvironmentInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `tagPatternInput`Optional + +```java +public java.lang.String getTagPatternInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `branchPattern`Required + +```java +public java.lang.String getBranchPattern(); +``` + +- *Type:* java.lang.String + +--- + +##### `environment`Required + +```java +public java.lang.String getEnvironment(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `tagPattern`Required + +```java +public java.lang.String getTagPattern(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### RepositoryEnvironmentDeploymentPolicyConfig + +#### Initializer + +```java +import io.cdktn.providers.github.repository_environment_deployment_policy.RepositoryEnvironmentDeploymentPolicyConfig; + +RepositoryEnvironmentDeploymentPolicyConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .environment(java.lang.String) + .repository(java.lang.String) +// .branchPattern(java.lang.String) +// .id(java.lang.String) +// .tagPattern(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 | *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 | *No description.* | +| environment | java.lang.String | The name of the environment. | +| repository | java.lang.String | The name of the GitHub repository. | +| branchPattern | java.lang.String | The name pattern that branches must match in order to deploy to the environment. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment_deployment_policy#id RepositoryEnvironmentDeploymentPolicy#id}. | +| tagPattern | java.lang.String | The name pattern that tags must match in order to deploy to the environment. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `environment`Required + +```java +public java.lang.String getEnvironment(); +``` + +- *Type:* java.lang.String + +The name of the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment_deployment_policy#environment RepositoryEnvironmentDeploymentPolicy#environment} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The name of the GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment_deployment_policy#repository RepositoryEnvironmentDeploymentPolicy#repository} + +--- + +##### `branchPattern`Optional + +```java +public java.lang.String getBranchPattern(); +``` + +- *Type:* java.lang.String + +The name pattern that branches must match in order to deploy to the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment_deployment_policy#branch_pattern RepositoryEnvironmentDeploymentPolicy#branch_pattern} + +--- + +##### `id`Optional + +```java +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/resources/repository_environment_deployment_policy#id RepositoryEnvironmentDeploymentPolicy#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. + +--- + +##### `tagPattern`Optional + +```java +public java.lang.String getTagPattern(); +``` + +- *Type:* java.lang.String + +The name pattern that tags must match in order to deploy to the environment. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_environment_deployment_policy#tag_pattern RepositoryEnvironmentDeploymentPolicy#tag_pattern} + +--- + + + diff --git a/docs/repositoryFile.csharp.md b/docs/repositoryFile.csharp.md new file mode 100644 index 000000000..b2c1e506a --- /dev/null +++ b/docs/repositoryFile.csharp.md @@ -0,0 +1,1362 @@ +# `repositoryFile` Submodule + +## Constructs + +### RepositoryFile + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file github_repository_file}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryFile(Construct Scope, string Id, RepositoryFileConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | RepositoryFileConfig | *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:* RepositoryFileConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetAutocreateBranch | *No description.* | +| ResetAutocreateBranchSourceBranch | *No description.* | +| ResetAutocreateBranchSourceSha | *No description.* | +| ResetBranch | *No description.* | +| ResetCommitAuthor | *No description.* | +| ResetCommitEmail | *No description.* | +| ResetCommitMessage | *No description.* | +| ResetId | *No description.* | +| ResetOverwriteOnCreate | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetAutocreateBranch` + +```csharp +private void ResetAutocreateBranch() +``` + +##### `ResetAutocreateBranchSourceBranch` + +```csharp +private void ResetAutocreateBranchSourceBranch() +``` + +##### `ResetAutocreateBranchSourceSha` + +```csharp +private void ResetAutocreateBranchSourceSha() +``` + +##### `ResetBranch` + +```csharp +private void ResetBranch() +``` + +##### `ResetCommitAuthor` + +```csharp +private void ResetCommitAuthor() +``` + +##### `ResetCommitEmail` + +```csharp +private void ResetCommitEmail() +``` + +##### `ResetCommitMessage` + +```csharp +private void ResetCommitMessage() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetOverwriteOnCreate` + +```csharp +private void ResetOverwriteOnCreate() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a RepositoryFile resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryFile.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` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryFile.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryFile.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryFile.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a RepositoryFile resource upon running "cdktn 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 RepositoryFile to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing RepositoryFile that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the RepositoryFile to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| CommitSha | string | *No description.* | +| Ref | string | *No description.* | +| RepositoryId | double | *No description.* | +| Sha | string | *No description.* | +| AutocreateBranchInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| AutocreateBranchSourceBranchInput | string | *No description.* | +| AutocreateBranchSourceShaInput | string | *No description.* | +| BranchInput | string | *No description.* | +| CommitAuthorInput | string | *No description.* | +| CommitEmailInput | string | *No description.* | +| CommitMessageInput | string | *No description.* | +| ContentInput | string | *No description.* | +| FileInput | string | *No description.* | +| IdInput | string | *No description.* | +| OverwriteOnCreateInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RepositoryInput | string | *No description.* | +| AutocreateBranch | bool\|Io.Cdktn.IResolvable | *No description.* | +| AutocreateBranchSourceBranch | string | *No description.* | +| AutocreateBranchSourceSha | string | *No description.* | +| Branch | string | *No description.* | +| CommitAuthor | string | *No description.* | +| CommitEmail | string | *No description.* | +| CommitMessage | string | *No description.* | +| Content | string | *No description.* | +| File | string | *No description.* | +| Id | string | *No description.* | +| OverwriteOnCreate | bool\|Io.Cdktn.IResolvable | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `CommitSha`Required + +```csharp +public string CommitSha { get; } +``` + +- *Type:* string + +--- + +##### `Ref`Required + +```csharp +public string Ref { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryId`Required + +```csharp +public double RepositoryId { get; } +``` + +- *Type:* double + +--- + +##### `Sha`Required + +```csharp +public string Sha { get; } +``` + +- *Type:* string + +--- + +##### `AutocreateBranchInput`Optional + +```csharp +public bool|IResolvable AutocreateBranchInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `AutocreateBranchSourceBranchInput`Optional + +```csharp +public string AutocreateBranchSourceBranchInput { get; } +``` + +- *Type:* string + +--- + +##### `AutocreateBranchSourceShaInput`Optional + +```csharp +public string AutocreateBranchSourceShaInput { get; } +``` + +- *Type:* string + +--- + +##### `BranchInput`Optional + +```csharp +public string BranchInput { get; } +``` + +- *Type:* string + +--- + +##### `CommitAuthorInput`Optional + +```csharp +public string CommitAuthorInput { get; } +``` + +- *Type:* string + +--- + +##### `CommitEmailInput`Optional + +```csharp +public string CommitEmailInput { get; } +``` + +- *Type:* string + +--- + +##### `CommitMessageInput`Optional + +```csharp +public string CommitMessageInput { get; } +``` + +- *Type:* string + +--- + +##### `ContentInput`Optional + +```csharp +public string ContentInput { get; } +``` + +- *Type:* string + +--- + +##### `FileInput`Optional + +```csharp +public string FileInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `OverwriteOnCreateInput`Optional + +```csharp +public bool|IResolvable OverwriteOnCreateInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `AutocreateBranch`Required + +```csharp +public bool|IResolvable AutocreateBranch { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `AutocreateBranchSourceBranch`Required + +```csharp +public string AutocreateBranchSourceBranch { get; } +``` + +- *Type:* string + +--- + +##### `AutocreateBranchSourceSha`Required + +```csharp +public string AutocreateBranchSourceSha { get; } +``` + +- *Type:* string + +--- + +##### `Branch`Required + +```csharp +public string Branch { get; } +``` + +- *Type:* string + +--- + +##### `CommitAuthor`Required + +```csharp +public string CommitAuthor { get; } +``` + +- *Type:* string + +--- + +##### `CommitEmail`Required + +```csharp +public string CommitEmail { get; } +``` + +- *Type:* string + +--- + +##### `CommitMessage`Required + +```csharp +public string CommitMessage { get; } +``` + +- *Type:* string + +--- + +##### `Content`Required + +```csharp +public string Content { get; } +``` + +- *Type:* string + +--- + +##### `File`Required + +```csharp +public string File { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `OverwriteOnCreate`Required + +```csharp +public bool|IResolvable OverwriteOnCreate { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### RepositoryFileConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryFileConfig { + 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 Content, + string File, + string Repository, + bool|IResolvable AutocreateBranch = null, + string AutocreateBranchSourceBranch = null, + string AutocreateBranchSourceSha = null, + string Branch = null, + string CommitAuthor = null, + string CommitEmail = null, + string CommitMessage = null, + string Id = null, + bool|IResolvable OverwriteOnCreate = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Content | string | The file's content. | +| File | string | The file path to manage. | +| Repository | string | The repository name. | +| AutocreateBranch | bool\|Io.Cdktn.IResolvable | Automatically create the branch if it could not be found. | +| AutocreateBranchSourceBranch | string | The branch name to start from, if 'autocreate_branch' is set. Defaults to 'main'. | +| AutocreateBranchSourceSha | string | The commit hash to start from, if 'autocreate_branch' is set. | +| Branch | string | The branch name, defaults to the repository's default branch. | +| CommitAuthor | string | The commit author name, defaults to the authenticated user's name. | +| CommitEmail | string | The commit author email address, defaults to the authenticated user's email address. | +| CommitMessage | string | The commit message when creating, updating or deleting the file. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#id RepositoryFile#id}. | +| OverwriteOnCreate | bool\|Io.Cdktn.IResolvable | Enable overwriting existing files, defaults to "false". | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Content`Required + +```csharp +public string Content { get; set; } +``` + +- *Type:* string + +The file's content. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#content RepositoryFile#content} + +--- + +##### `File`Required + +```csharp +public string File { get; set; } +``` + +- *Type:* string + +The file path to manage. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#file RepositoryFile#file} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#repository RepositoryFile#repository} + +--- + +##### `AutocreateBranch`Optional + +```csharp +public bool|IResolvable AutocreateBranch { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Automatically create the branch if it could not be found. + +Subsequent reads if the branch is deleted will occur from 'autocreate_branch_source_branch' + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#autocreate_branch RepositoryFile#autocreate_branch} + +--- + +##### `AutocreateBranchSourceBranch`Optional + +```csharp +public string AutocreateBranchSourceBranch { get; set; } +``` + +- *Type:* string + +The branch name to start from, if 'autocreate_branch' is set. Defaults to 'main'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#autocreate_branch_source_branch RepositoryFile#autocreate_branch_source_branch} + +--- + +##### `AutocreateBranchSourceSha`Optional + +```csharp +public string AutocreateBranchSourceSha { get; set; } +``` + +- *Type:* string + +The commit hash to start from, if 'autocreate_branch' is set. + +Defaults to the tip of 'autocreate_branch_source_branch'. If provided, 'autocreate_branch_source_branch' is ignored. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#autocreate_branch_source_sha RepositoryFile#autocreate_branch_source_sha} + +--- + +##### `Branch`Optional + +```csharp +public string Branch { get; set; } +``` + +- *Type:* string + +The branch name, defaults to the repository's default branch. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#branch RepositoryFile#branch} + +--- + +##### `CommitAuthor`Optional + +```csharp +public string CommitAuthor { get; set; } +``` + +- *Type:* string + +The commit author name, defaults to the authenticated user's name. + +GitHub app users may omit author and email information so GitHub can verify commits as the GitHub App. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#commit_author RepositoryFile#commit_author} + +--- + +##### `CommitEmail`Optional + +```csharp +public string CommitEmail { get; set; } +``` + +- *Type:* string + +The commit author email address, defaults to the authenticated user's email address. + +GitHub app users may omit author and email information so GitHub can verify commits as the GitHub App. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#commit_email RepositoryFile#commit_email} + +--- + +##### `CommitMessage`Optional + +```csharp +public string CommitMessage { get; set; } +``` + +- *Type:* string + +The commit message when creating, updating or deleting the file. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#commit_message RepositoryFile#commit_message} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#id RepositoryFile#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. + +--- + +##### `OverwriteOnCreate`Optional + +```csharp +public bool|IResolvable OverwriteOnCreate { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Enable overwriting existing files, defaults to "false". + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#overwrite_on_create RepositoryFile#overwrite_on_create} + +--- + + + diff --git a/docs/repositoryFile.java.md b/docs/repositoryFile.java.md new file mode 100644 index 000000000..35fc18495 --- /dev/null +++ b/docs/repositoryFile.java.md @@ -0,0 +1,1567 @@ +# `repositoryFile` Submodule + +## Constructs + +### RepositoryFile + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file github_repository_file}. + +#### Initializers + +```java +import io.cdktn.providers.github.repository_file.RepositoryFile; + +RepositoryFile.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .content(java.lang.String) + .file(java.lang.String) + .repository(java.lang.String) +// .autocreateBranch(java.lang.Boolean|IResolvable) +// .autocreateBranchSourceBranch(java.lang.String) +// .autocreateBranchSourceSha(java.lang.String) +// .branch(java.lang.String) +// .commitAuthor(java.lang.String) +// .commitEmail(java.lang.String) +// .commitMessage(java.lang.String) +// .id(java.lang.String) +// .overwriteOnCreate(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 | *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 | *No description.* | +| content | java.lang.String | The file's content. | +| file | java.lang.String | The file path to manage. | +| repository | java.lang.String | The repository name. | +| autocreateBranch | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Automatically create the branch if it could not be found. | +| autocreateBranchSourceBranch | java.lang.String | The branch name to start from, if 'autocreate_branch' is set. Defaults to 'main'. | +| autocreateBranchSourceSha | java.lang.String | The commit hash to start from, if 'autocreate_branch' is set. | +| branch | java.lang.String | The branch name, defaults to the repository's default branch. | +| commitAuthor | java.lang.String | The commit author name, defaults to the authenticated user's name. | +| commitEmail | java.lang.String | The commit author email address, defaults to the authenticated user's email address. | +| commitMessage | java.lang.String | The commit message when creating, updating or deleting the file. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#id RepositoryFile#id}. | +| overwriteOnCreate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Enable overwriting existing files, defaults to "false". | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `content`Required + +- *Type:* java.lang.String + +The file's content. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#content RepositoryFile#content} + +--- + +##### `file`Required + +- *Type:* java.lang.String + +The file path to manage. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#file RepositoryFile#file} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#repository RepositoryFile#repository} + +--- + +##### `autocreateBranch`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Automatically create the branch if it could not be found. + +Subsequent reads if the branch is deleted will occur from 'autocreate_branch_source_branch' + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#autocreate_branch RepositoryFile#autocreate_branch} + +--- + +##### `autocreateBranchSourceBranch`Optional + +- *Type:* java.lang.String + +The branch name to start from, if 'autocreate_branch' is set. Defaults to 'main'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#autocreate_branch_source_branch RepositoryFile#autocreate_branch_source_branch} + +--- + +##### `autocreateBranchSourceSha`Optional + +- *Type:* java.lang.String + +The commit hash to start from, if 'autocreate_branch' is set. + +Defaults to the tip of 'autocreate_branch_source_branch'. If provided, 'autocreate_branch_source_branch' is ignored. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#autocreate_branch_source_sha RepositoryFile#autocreate_branch_source_sha} + +--- + +##### `branch`Optional + +- *Type:* java.lang.String + +The branch name, defaults to the repository's default branch. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#branch RepositoryFile#branch} + +--- + +##### `commitAuthor`Optional + +- *Type:* java.lang.String + +The commit author name, defaults to the authenticated user's name. + +GitHub app users may omit author and email information so GitHub can verify commits as the GitHub App. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#commit_author RepositoryFile#commit_author} + +--- + +##### `commitEmail`Optional + +- *Type:* java.lang.String + +The commit author email address, defaults to the authenticated user's email address. + +GitHub app users may omit author and email information so GitHub can verify commits as the GitHub App. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#commit_email RepositoryFile#commit_email} + +--- + +##### `commitMessage`Optional + +- *Type:* java.lang.String + +The commit message when creating, updating or deleting the file. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#commit_message RepositoryFile#commit_message} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#id RepositoryFile#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. + +--- + +##### `overwriteOnCreate`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Enable overwriting existing files, defaults to "false". + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#overwrite_on_create RepositoryFile#overwrite_on_create} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetAutocreateBranch | *No description.* | +| resetAutocreateBranchSourceBranch | *No description.* | +| resetAutocreateBranchSourceSha | *No description.* | +| resetBranch | *No description.* | +| resetCommitAuthor | *No description.* | +| resetCommitEmail | *No description.* | +| resetCommitMessage | *No description.* | +| resetId | *No description.* | +| resetOverwriteOnCreate | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetAutocreateBranch` + +```java +public void resetAutocreateBranch() +``` + +##### `resetAutocreateBranchSourceBranch` + +```java +public void resetAutocreateBranchSourceBranch() +``` + +##### `resetAutocreateBranchSourceSha` + +```java +public void resetAutocreateBranchSourceSha() +``` + +##### `resetBranch` + +```java +public void resetBranch() +``` + +##### `resetCommitAuthor` + +```java +public void resetCommitAuthor() +``` + +##### `resetCommitEmail` + +```java +public void resetCommitEmail() +``` + +##### `resetCommitMessage` + +```java +public void resetCommitMessage() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetOverwriteOnCreate` + +```java +public void resetOverwriteOnCreate() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a RepositoryFile resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.repository_file.RepositoryFile; + +RepositoryFile.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` + +```java +import io.cdktn.providers.github.repository_file.RepositoryFile; + +RepositoryFile.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.repository_file.RepositoryFile; + +RepositoryFile.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.repository_file.RepositoryFile; + +RepositoryFile.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),RepositoryFile.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a RepositoryFile 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 RepositoryFile to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing RepositoryFile that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#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 RepositoryFile 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| commitSha | java.lang.String | *No description.* | +| ref | java.lang.String | *No description.* | +| repositoryId | java.lang.Number | *No description.* | +| sha | java.lang.String | *No description.* | +| autocreateBranchInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| autocreateBranchSourceBranchInput | java.lang.String | *No description.* | +| autocreateBranchSourceShaInput | java.lang.String | *No description.* | +| branchInput | java.lang.String | *No description.* | +| commitAuthorInput | java.lang.String | *No description.* | +| commitEmailInput | java.lang.String | *No description.* | +| commitMessageInput | java.lang.String | *No description.* | +| contentInput | java.lang.String | *No description.* | +| fileInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| overwriteOnCreateInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| autocreateBranch | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| autocreateBranchSourceBranch | java.lang.String | *No description.* | +| autocreateBranchSourceSha | java.lang.String | *No description.* | +| branch | java.lang.String | *No description.* | +| commitAuthor | java.lang.String | *No description.* | +| commitEmail | java.lang.String | *No description.* | +| commitMessage | java.lang.String | *No description.* | +| content | java.lang.String | *No description.* | +| file | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| overwriteOnCreate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `commitSha`Required + +```java +public java.lang.String getCommitSha(); +``` + +- *Type:* java.lang.String + +--- + +##### `ref`Required + +```java +public java.lang.String getRef(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryId`Required + +```java +public java.lang.Number getRepositoryId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `sha`Required + +```java +public java.lang.String getSha(); +``` + +- *Type:* java.lang.String + +--- + +##### `autocreateBranchInput`Optional + +```java +public java.lang.Boolean|IResolvable getAutocreateBranchInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `autocreateBranchSourceBranchInput`Optional + +```java +public java.lang.String getAutocreateBranchSourceBranchInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `autocreateBranchSourceShaInput`Optional + +```java +public java.lang.String getAutocreateBranchSourceShaInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `branchInput`Optional + +```java +public java.lang.String getBranchInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `commitAuthorInput`Optional + +```java +public java.lang.String getCommitAuthorInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `commitEmailInput`Optional + +```java +public java.lang.String getCommitEmailInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `commitMessageInput`Optional + +```java +public java.lang.String getCommitMessageInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `contentInput`Optional + +```java +public java.lang.String getContentInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `fileInput`Optional + +```java +public java.lang.String getFileInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `overwriteOnCreateInput`Optional + +```java +public java.lang.Boolean|IResolvable getOverwriteOnCreateInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `autocreateBranch`Required + +```java +public java.lang.Boolean|IResolvable getAutocreateBranch(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `autocreateBranchSourceBranch`Required + +```java +public java.lang.String getAutocreateBranchSourceBranch(); +``` + +- *Type:* java.lang.String + +--- + +##### `autocreateBranchSourceSha`Required + +```java +public java.lang.String getAutocreateBranchSourceSha(); +``` + +- *Type:* java.lang.String + +--- + +##### `branch`Required + +```java +public java.lang.String getBranch(); +``` + +- *Type:* java.lang.String + +--- + +##### `commitAuthor`Required + +```java +public java.lang.String getCommitAuthor(); +``` + +- *Type:* java.lang.String + +--- + +##### `commitEmail`Required + +```java +public java.lang.String getCommitEmail(); +``` + +- *Type:* java.lang.String + +--- + +##### `commitMessage`Required + +```java +public java.lang.String getCommitMessage(); +``` + +- *Type:* java.lang.String + +--- + +##### `content`Required + +```java +public java.lang.String getContent(); +``` + +- *Type:* java.lang.String + +--- + +##### `file`Required + +```java +public java.lang.String getFile(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `overwriteOnCreate`Required + +```java +public java.lang.Boolean|IResolvable getOverwriteOnCreate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### RepositoryFileConfig + +#### Initializer + +```java +import io.cdktn.providers.github.repository_file.RepositoryFileConfig; + +RepositoryFileConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .content(java.lang.String) + .file(java.lang.String) + .repository(java.lang.String) +// .autocreateBranch(java.lang.Boolean|IResolvable) +// .autocreateBranchSourceBranch(java.lang.String) +// .autocreateBranchSourceSha(java.lang.String) +// .branch(java.lang.String) +// .commitAuthor(java.lang.String) +// .commitEmail(java.lang.String) +// .commitMessage(java.lang.String) +// .id(java.lang.String) +// .overwriteOnCreate(java.lang.Boolean|IResolvable) + .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 | *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 | *No description.* | +| content | java.lang.String | The file's content. | +| file | java.lang.String | The file path to manage. | +| repository | java.lang.String | The repository name. | +| autocreateBranch | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Automatically create the branch if it could not be found. | +| autocreateBranchSourceBranch | java.lang.String | The branch name to start from, if 'autocreate_branch' is set. Defaults to 'main'. | +| autocreateBranchSourceSha | java.lang.String | The commit hash to start from, if 'autocreate_branch' is set. | +| branch | java.lang.String | The branch name, defaults to the repository's default branch. | +| commitAuthor | java.lang.String | The commit author name, defaults to the authenticated user's name. | +| commitEmail | java.lang.String | The commit author email address, defaults to the authenticated user's email address. | +| commitMessage | java.lang.String | The commit message when creating, updating or deleting the file. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#id RepositoryFile#id}. | +| overwriteOnCreate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Enable overwriting existing files, defaults to "false". | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `content`Required + +```java +public java.lang.String getContent(); +``` + +- *Type:* java.lang.String + +The file's content. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#content RepositoryFile#content} + +--- + +##### `file`Required + +```java +public java.lang.String getFile(); +``` + +- *Type:* java.lang.String + +The file path to manage. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#file RepositoryFile#file} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The repository name. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#repository RepositoryFile#repository} + +--- + +##### `autocreateBranch`Optional + +```java +public java.lang.Boolean|IResolvable getAutocreateBranch(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Automatically create the branch if it could not be found. + +Subsequent reads if the branch is deleted will occur from 'autocreate_branch_source_branch' + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#autocreate_branch RepositoryFile#autocreate_branch} + +--- + +##### `autocreateBranchSourceBranch`Optional + +```java +public java.lang.String getAutocreateBranchSourceBranch(); +``` + +- *Type:* java.lang.String + +The branch name to start from, if 'autocreate_branch' is set. Defaults to 'main'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#autocreate_branch_source_branch RepositoryFile#autocreate_branch_source_branch} + +--- + +##### `autocreateBranchSourceSha`Optional + +```java +public java.lang.String getAutocreateBranchSourceSha(); +``` + +- *Type:* java.lang.String + +The commit hash to start from, if 'autocreate_branch' is set. + +Defaults to the tip of 'autocreate_branch_source_branch'. If provided, 'autocreate_branch_source_branch' is ignored. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#autocreate_branch_source_sha RepositoryFile#autocreate_branch_source_sha} + +--- + +##### `branch`Optional + +```java +public java.lang.String getBranch(); +``` + +- *Type:* java.lang.String + +The branch name, defaults to the repository's default branch. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#branch RepositoryFile#branch} + +--- + +##### `commitAuthor`Optional + +```java +public java.lang.String getCommitAuthor(); +``` + +- *Type:* java.lang.String + +The commit author name, defaults to the authenticated user's name. + +GitHub app users may omit author and email information so GitHub can verify commits as the GitHub App. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#commit_author RepositoryFile#commit_author} + +--- + +##### `commitEmail`Optional + +```java +public java.lang.String getCommitEmail(); +``` + +- *Type:* java.lang.String + +The commit author email address, defaults to the authenticated user's email address. + +GitHub app users may omit author and email information so GitHub can verify commits as the GitHub App. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#commit_email RepositoryFile#commit_email} + +--- + +##### `commitMessage`Optional + +```java +public java.lang.String getCommitMessage(); +``` + +- *Type:* java.lang.String + +The commit message when creating, updating or deleting the file. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#commit_message RepositoryFile#commit_message} + +--- + +##### `id`Optional + +```java +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/resources/repository_file#id RepositoryFile#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. + +--- + +##### `overwriteOnCreate`Optional + +```java +public java.lang.Boolean|IResolvable getOverwriteOnCreate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Enable overwriting existing files, defaults to "false". + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_file#overwrite_on_create RepositoryFile#overwrite_on_create} + +--- + + + diff --git a/docs/repositoryMilestone.csharp.md b/docs/repositoryMilestone.csharp.md new file mode 100644 index 000000000..7c97d73b9 --- /dev/null +++ b/docs/repositoryMilestone.csharp.md @@ -0,0 +1,1096 @@ +# `repositoryMilestone` Submodule + +## Constructs + +### RepositoryMilestone + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone github_repository_milestone}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryMilestone(Construct Scope, string Id, RepositoryMilestoneConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | RepositoryMilestoneConfig | *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:* RepositoryMilestoneConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetDescription | *No description.* | +| ResetDueDate | *No description.* | +| ResetId | *No description.* | +| ResetState | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetDescription` + +```csharp +private void ResetDescription() +``` + +##### `ResetDueDate` + +```csharp +private void ResetDueDate() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetState` + +```csharp +private void ResetState() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a RepositoryMilestone resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryMilestone.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` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryMilestone.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryMilestone.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryMilestone.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a RepositoryMilestone resource upon running "cdktn 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 RepositoryMilestone to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing RepositoryMilestone that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the RepositoryMilestone to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Number | double | *No description.* | +| DescriptionInput | string | *No description.* | +| DueDateInput | string | *No description.* | +| IdInput | string | *No description.* | +| OwnerInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| StateInput | string | *No description.* | +| TitleInput | string | *No description.* | +| Description | string | *No description.* | +| DueDate | string | *No description.* | +| Id | string | *No description.* | +| Owner | string | *No description.* | +| Repository | string | *No description.* | +| State | string | *No description.* | +| Title | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Number`Required + +```csharp +public double Number { get; } +``` + +- *Type:* double + +--- + +##### `DescriptionInput`Optional + +```csharp +public string DescriptionInput { get; } +``` + +- *Type:* string + +--- + +##### `DueDateInput`Optional + +```csharp +public string DueDateInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `OwnerInput`Optional + +```csharp +public string OwnerInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `StateInput`Optional + +```csharp +public string StateInput { get; } +``` + +- *Type:* string + +--- + +##### `TitleInput`Optional + +```csharp +public string TitleInput { get; } +``` + +- *Type:* string + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `DueDate`Required + +```csharp +public string DueDate { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Owner`Required + +```csharp +public string Owner { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `State`Required + +```csharp +public string State { get; } +``` + +- *Type:* string + +--- + +##### `Title`Required + +```csharp +public string Title { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### RepositoryMilestoneConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryMilestoneConfig { + 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 Owner, + string Repository, + string Title, + string Description = null, + string DueDate = null, + string Id = null, + string State = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Owner | string | The owner of the GitHub Repository. | +| Repository | string | The name of the GitHub Repository. | +| Title | string | The title of the milestone. | +| Description | string | A description of the milestone. | +| DueDate | string | The milestone due date. In 'yyyy-mm-dd' format. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#id RepositoryMilestone#id}. | +| State | string | The state of the milestone. Either 'open' or 'closed'. Default: 'open'. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Owner`Required + +```csharp +public string Owner { get; set; } +``` + +- *Type:* string + +The owner of the GitHub Repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#owner RepositoryMilestone#owner} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The name of the GitHub Repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#repository RepositoryMilestone#repository} + +--- + +##### `Title`Required + +```csharp +public string Title { get; set; } +``` + +- *Type:* string + +The title of the milestone. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#title RepositoryMilestone#title} + +--- + +##### `Description`Optional + +```csharp +public string Description { get; set; } +``` + +- *Type:* string + +A description of the milestone. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#description RepositoryMilestone#description} + +--- + +##### `DueDate`Optional + +```csharp +public string DueDate { get; set; } +``` + +- *Type:* string + +The milestone due date. In 'yyyy-mm-dd' format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#due_date RepositoryMilestone#due_date} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#id RepositoryMilestone#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. + +--- + +##### `State`Optional + +```csharp +public string State { get; set; } +``` + +- *Type:* string + +The state of the milestone. Either 'open' or 'closed'. Default: 'open'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#state RepositoryMilestone#state} + +--- + + + diff --git a/docs/repositoryMilestone.java.md b/docs/repositoryMilestone.java.md new file mode 100644 index 000000000..52b53b3ec --- /dev/null +++ b/docs/repositoryMilestone.java.md @@ -0,0 +1,1233 @@ +# `repositoryMilestone` Submodule + +## Constructs + +### RepositoryMilestone + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone github_repository_milestone}. + +#### Initializers + +```java +import io.cdktn.providers.github.repository_milestone.RepositoryMilestone; + +RepositoryMilestone.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .owner(java.lang.String) + .repository(java.lang.String) + .title(java.lang.String) +// .description(java.lang.String) +// .dueDate(java.lang.String) +// .id(java.lang.String) +// .state(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 | *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 | *No description.* | +| owner | java.lang.String | The owner of the GitHub Repository. | +| repository | java.lang.String | The name of the GitHub Repository. | +| title | java.lang.String | The title of the milestone. | +| description | java.lang.String | A description of the milestone. | +| dueDate | java.lang.String | The milestone due date. In 'yyyy-mm-dd' format. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#id RepositoryMilestone#id}. | +| state | java.lang.String | The state of the milestone. Either 'open' or 'closed'. Default: 'open'. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `owner`Required + +- *Type:* java.lang.String + +The owner of the GitHub Repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#owner RepositoryMilestone#owner} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The name of the GitHub Repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#repository RepositoryMilestone#repository} + +--- + +##### `title`Required + +- *Type:* java.lang.String + +The title of the milestone. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#title RepositoryMilestone#title} + +--- + +##### `description`Optional + +- *Type:* java.lang.String + +A description of the milestone. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#description RepositoryMilestone#description} + +--- + +##### `dueDate`Optional + +- *Type:* java.lang.String + +The milestone due date. In 'yyyy-mm-dd' format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#due_date RepositoryMilestone#due_date} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#id RepositoryMilestone#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. + +--- + +##### `state`Optional + +- *Type:* java.lang.String + +The state of the milestone. Either 'open' or 'closed'. Default: 'open'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#state RepositoryMilestone#state} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetDescription | *No description.* | +| resetDueDate | *No description.* | +| resetId | *No description.* | +| resetState | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetDescription` + +```java +public void resetDescription() +``` + +##### `resetDueDate` + +```java +public void resetDueDate() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetState` + +```java +public void resetState() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a RepositoryMilestone resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.repository_milestone.RepositoryMilestone; + +RepositoryMilestone.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` + +```java +import io.cdktn.providers.github.repository_milestone.RepositoryMilestone; + +RepositoryMilestone.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.repository_milestone.RepositoryMilestone; + +RepositoryMilestone.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.repository_milestone.RepositoryMilestone; + +RepositoryMilestone.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),RepositoryMilestone.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a RepositoryMilestone 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 RepositoryMilestone to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing RepositoryMilestone that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#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 RepositoryMilestone 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| number | java.lang.Number | *No description.* | +| descriptionInput | java.lang.String | *No description.* | +| dueDateInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| ownerInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| stateInput | java.lang.String | *No description.* | +| titleInput | java.lang.String | *No description.* | +| description | java.lang.String | *No description.* | +| dueDate | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| owner | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | +| state | java.lang.String | *No description.* | +| title | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `number`Required + +```java +public java.lang.Number getNumber(); +``` + +- *Type:* java.lang.Number + +--- + +##### `descriptionInput`Optional + +```java +public java.lang.String getDescriptionInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `dueDateInput`Optional + +```java +public java.lang.String getDueDateInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `ownerInput`Optional + +```java +public java.lang.String getOwnerInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `stateInput`Optional + +```java +public java.lang.String getStateInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `titleInput`Optional + +```java +public java.lang.String getTitleInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `dueDate`Required + +```java +public java.lang.String getDueDate(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `owner`Required + +```java +public java.lang.String getOwner(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `state`Required + +```java +public java.lang.String getState(); +``` + +- *Type:* java.lang.String + +--- + +##### `title`Required + +```java +public java.lang.String getTitle(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### RepositoryMilestoneConfig + +#### Initializer + +```java +import io.cdktn.providers.github.repository_milestone.RepositoryMilestoneConfig; + +RepositoryMilestoneConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .owner(java.lang.String) + .repository(java.lang.String) + .title(java.lang.String) +// .description(java.lang.String) +// .dueDate(java.lang.String) +// .id(java.lang.String) +// .state(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 | *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 | *No description.* | +| owner | java.lang.String | The owner of the GitHub Repository. | +| repository | java.lang.String | The name of the GitHub Repository. | +| title | java.lang.String | The title of the milestone. | +| description | java.lang.String | A description of the milestone. | +| dueDate | java.lang.String | The milestone due date. In 'yyyy-mm-dd' format. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#id RepositoryMilestone#id}. | +| state | java.lang.String | The state of the milestone. Either 'open' or 'closed'. Default: 'open'. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `owner`Required + +```java +public java.lang.String getOwner(); +``` + +- *Type:* java.lang.String + +The owner of the GitHub Repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#owner RepositoryMilestone#owner} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The name of the GitHub Repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#repository RepositoryMilestone#repository} + +--- + +##### `title`Required + +```java +public java.lang.String getTitle(); +``` + +- *Type:* java.lang.String + +The title of the milestone. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#title RepositoryMilestone#title} + +--- + +##### `description`Optional + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +A description of the milestone. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#description RepositoryMilestone#description} + +--- + +##### `dueDate`Optional + +```java +public java.lang.String getDueDate(); +``` + +- *Type:* java.lang.String + +The milestone due date. In 'yyyy-mm-dd' format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#due_date RepositoryMilestone#due_date} + +--- + +##### `id`Optional + +```java +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/resources/repository_milestone#id RepositoryMilestone#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. + +--- + +##### `state`Optional + +```java +public java.lang.String getState(); +``` + +- *Type:* java.lang.String + +The state of the milestone. Either 'open' or 'closed'. Default: 'open'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_milestone#state RepositoryMilestone#state} + +--- + + + diff --git a/docs/repositoryPages.csharp.md b/docs/repositoryPages.csharp.md new file mode 100644 index 000000000..e71d5fe0d --- /dev/null +++ b/docs/repositoryPages.csharp.md @@ -0,0 +1,1520 @@ +# `repositoryPages` Submodule + +## Constructs + +### RepositoryPagesA + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages github_repository_pages}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryPagesA(Construct Scope, string Id, RepositoryPagesAConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | RepositoryPagesAConfig | *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:* RepositoryPagesAConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| PutSource | *No description.* | +| ResetBuildType | *No description.* | +| ResetCname | *No description.* | +| ResetHttpsEnforced | *No description.* | +| ResetId | *No description.* | +| ResetPublic | *No description.* | +| ResetSource | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `PutSource` + +```csharp +private void PutSource(RepositoryPagesSourceA Value) +``` + +###### `Value`Required + +- *Type:* RepositoryPagesSourceA + +--- + +##### `ResetBuildType` + +```csharp +private void ResetBuildType() +``` + +##### `ResetCname` + +```csharp +private void ResetCname() +``` + +##### `ResetHttpsEnforced` + +```csharp +private void ResetHttpsEnforced() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetPublic` + +```csharp +private void ResetPublic() +``` + +##### `ResetSource` + +```csharp +private void ResetSource() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a RepositoryPagesA resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryPagesA.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` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryPagesA.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryPagesA.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryPagesA.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a RepositoryPagesA resource upon running "cdktn 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 RepositoryPagesA to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing RepositoryPagesA that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the RepositoryPagesA to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| ApiUrl | string | *No description.* | +| BuildStatus | string | *No description.* | +| Custom404 | Io.Cdktn.IResolvable | *No description.* | +| HtmlUrl | string | *No description.* | +| RepositoryId | double | *No description.* | +| Source | RepositoryPagesSourceAOutputReference | *No description.* | +| BuildTypeInput | string | *No description.* | +| CnameInput | string | *No description.* | +| HttpsEnforcedInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| IdInput | string | *No description.* | +| PublicInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RepositoryInput | string | *No description.* | +| SourceInput | RepositoryPagesSourceA | *No description.* | +| BuildType | string | *No description.* | +| Cname | string | *No description.* | +| HttpsEnforced | bool\|Io.Cdktn.IResolvable | *No description.* | +| Id | string | *No description.* | +| Public | bool\|Io.Cdktn.IResolvable | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `ApiUrl`Required + +```csharp +public string ApiUrl { get; } +``` + +- *Type:* string + +--- + +##### `BuildStatus`Required + +```csharp +public string BuildStatus { get; } +``` + +- *Type:* string + +--- + +##### `Custom404`Required + +```csharp +public IResolvable Custom404 { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `HtmlUrl`Required + +```csharp +public string HtmlUrl { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryId`Required + +```csharp +public double RepositoryId { get; } +``` + +- *Type:* double + +--- + +##### `Source`Required + +```csharp +public RepositoryPagesSourceAOutputReference Source { get; } +``` + +- *Type:* RepositoryPagesSourceAOutputReference + +--- + +##### `BuildTypeInput`Optional + +```csharp +public string BuildTypeInput { get; } +``` + +- *Type:* string + +--- + +##### `CnameInput`Optional + +```csharp +public string CnameInput { get; } +``` + +- *Type:* string + +--- + +##### `HttpsEnforcedInput`Optional + +```csharp +public bool|IResolvable HttpsEnforcedInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `PublicInput`Optional + +```csharp +public bool|IResolvable PublicInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `SourceInput`Optional + +```csharp +public RepositoryPagesSourceA SourceInput { get; } +``` + +- *Type:* RepositoryPagesSourceA + +--- + +##### `BuildType`Required + +```csharp +public string BuildType { get; } +``` + +- *Type:* string + +--- + +##### `Cname`Required + +```csharp +public string Cname { get; } +``` + +- *Type:* string + +--- + +##### `HttpsEnforced`Required + +```csharp +public bool|IResolvable HttpsEnforced { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Public`Required + +```csharp +public bool|IResolvable Public { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### RepositoryPagesAConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryPagesAConfig { + 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 Repository, + string BuildType = null, + string Cname = null, + bool|IResolvable HttpsEnforced = null, + string Id = null, + bool|IResolvable Public = null, + RepositoryPagesSourceA Source = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | The repository name to configure GitHub Pages for. | +| BuildType | string | The type of GitHub Pages site to build. Can be 'legacy' or 'workflow'. | +| Cname | string | The custom domain for the repository. | +| HttpsEnforced | bool\|Io.Cdktn.IResolvable | Whether the rendered GitHub Pages site will only be served over HTTPS. Requires 'cname' to be set. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#id RepositoryPagesA#id}. | +| Public | bool\|Io.Cdktn.IResolvable | Whether the GitHub Pages site is publicly visible. | +| Source | RepositoryPagesSourceA | source block. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The repository name to configure GitHub Pages for. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#repository RepositoryPagesA#repository} + +--- + +##### `BuildType`Optional + +```csharp +public string BuildType { get; set; } +``` + +- *Type:* string + +The type of GitHub Pages site to build. Can be 'legacy' or 'workflow'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#build_type RepositoryPagesA#build_type} + +--- + +##### `Cname`Optional + +```csharp +public string Cname { get; set; } +``` + +- *Type:* string + +The custom domain for the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#cname RepositoryPagesA#cname} + +--- + +##### `HttpsEnforced`Optional + +```csharp +public bool|IResolvable HttpsEnforced { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether the rendered GitHub Pages site will only be served over HTTPS. Requires 'cname' to be set. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#https_enforced RepositoryPagesA#https_enforced} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#id RepositoryPagesA#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`Optional + +```csharp +public bool|IResolvable Public { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether the GitHub Pages site is publicly visible. + +If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#public RepositoryPagesA#public} + +--- + +##### `Source`Optional + +```csharp +public RepositoryPagesSourceA Source { get; set; } +``` + +- *Type:* RepositoryPagesSourceA + +source block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#source RepositoryPagesA#source} + +--- + +### RepositoryPagesSourceA + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryPagesSourceA { + string Branch, + string Path = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Branch | string | The repository branch used to publish the site's source files. (i.e. 'main' or 'gh-pages'). | +| Path | string | The repository directory from which the site publishes (Default: '/'). | + +--- + +##### `Branch`Required + +```csharp +public string Branch { get; set; } +``` + +- *Type:* string + +The repository branch used to publish the site's source files. (i.e. 'main' or 'gh-pages'). + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#branch RepositoryPagesA#branch} + +--- + +##### `Path`Optional + +```csharp +public string Path { get; set; } +``` + +- *Type:* string + +The repository directory from which the site publishes (Default: '/'). + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#path RepositoryPagesA#path} + +--- + +## Classes + +### RepositoryPagesSourceAOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryPagesSourceAOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetPath | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetPath` + +```csharp +private void ResetPath() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| BranchInput | string | *No description.* | +| PathInput | string | *No description.* | +| Branch | string | *No description.* | +| Path | string | *No description.* | +| InternalValue | RepositoryPagesSourceA | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `BranchInput`Optional + +```csharp +public string BranchInput { get; } +``` + +- *Type:* string + +--- + +##### `PathInput`Optional + +```csharp +public string PathInput { get; } +``` + +- *Type:* string + +--- + +##### `Branch`Required + +```csharp +public string Branch { get; } +``` + +- *Type:* string + +--- + +##### `Path`Required + +```csharp +public string Path { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryPagesSourceA InternalValue { get; } +``` + +- *Type:* RepositoryPagesSourceA + +--- + + + diff --git a/docs/repositoryPages.java.md b/docs/repositoryPages.java.md new file mode 100644 index 000000000..2c918dd98 --- /dev/null +++ b/docs/repositoryPages.java.md @@ -0,0 +1,1659 @@ +# `repositoryPages` Submodule + +## Constructs + +### RepositoryPagesA + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages github_repository_pages}. + +#### Initializers + +```java +import io.cdktn.providers.github.repository_pages.RepositoryPagesA; + +RepositoryPagesA.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .buildType(java.lang.String) +// .cname(java.lang.String) +// .httpsEnforced(java.lang.Boolean|IResolvable) +// .id(java.lang.String) +// .public(java.lang.Boolean|IResolvable) +// .source(RepositoryPagesSourceA) + .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 | *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 | *No description.* | +| repository | java.lang.String | The repository name to configure GitHub Pages for. | +| buildType | java.lang.String | The type of GitHub Pages site to build. Can be 'legacy' or 'workflow'. | +| cname | java.lang.String | The custom domain for the repository. | +| httpsEnforced | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether the rendered GitHub Pages site will only be served over HTTPS. Requires 'cname' to be set. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#id RepositoryPagesA#id}. | +| public | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether the GitHub Pages site is publicly visible. | +| source | RepositoryPagesSourceA | source block. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The repository name to configure GitHub Pages for. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#repository RepositoryPagesA#repository} + +--- + +##### `buildType`Optional + +- *Type:* java.lang.String + +The type of GitHub Pages site to build. Can be 'legacy' or 'workflow'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#build_type RepositoryPagesA#build_type} + +--- + +##### `cname`Optional + +- *Type:* java.lang.String + +The custom domain for the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#cname RepositoryPagesA#cname} + +--- + +##### `httpsEnforced`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether the rendered GitHub Pages site will only be served over HTTPS. Requires 'cname' to be set. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#https_enforced RepositoryPagesA#https_enforced} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#id RepositoryPagesA#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`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether the GitHub Pages site is publicly visible. + +If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#public RepositoryPagesA#public} + +--- + +##### `source`Optional + +- *Type:* RepositoryPagesSourceA + +source block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#source RepositoryPagesA#source} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| putSource | *No description.* | +| resetBuildType | *No description.* | +| resetCname | *No description.* | +| resetHttpsEnforced | *No description.* | +| resetId | *No description.* | +| resetPublic | *No description.* | +| resetSource | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `putSource` + +```java +public void putSource(RepositoryPagesSourceA value) +``` + +###### `value`Required + +- *Type:* RepositoryPagesSourceA + +--- + +##### `resetBuildType` + +```java +public void resetBuildType() +``` + +##### `resetCname` + +```java +public void resetCname() +``` + +##### `resetHttpsEnforced` + +```java +public void resetHttpsEnforced() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetPublic` + +```java +public void resetPublic() +``` + +##### `resetSource` + +```java +public void resetSource() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a RepositoryPagesA resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.repository_pages.RepositoryPagesA; + +RepositoryPagesA.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` + +```java +import io.cdktn.providers.github.repository_pages.RepositoryPagesA; + +RepositoryPagesA.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.repository_pages.RepositoryPagesA; + +RepositoryPagesA.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.repository_pages.RepositoryPagesA; + +RepositoryPagesA.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),RepositoryPagesA.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a RepositoryPagesA 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 RepositoryPagesA to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing RepositoryPagesA that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#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 RepositoryPagesA 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| apiUrl | java.lang.String | *No description.* | +| buildStatus | java.lang.String | *No description.* | +| custom404 | io.cdktn.cdktn.IResolvable | *No description.* | +| htmlUrl | java.lang.String | *No description.* | +| repositoryId | java.lang.Number | *No description.* | +| source | RepositoryPagesSourceAOutputReference | *No description.* | +| buildTypeInput | java.lang.String | *No description.* | +| cnameInput | java.lang.String | *No description.* | +| httpsEnforcedInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| idInput | java.lang.String | *No description.* | +| publicInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| sourceInput | RepositoryPagesSourceA | *No description.* | +| buildType | java.lang.String | *No description.* | +| cname | java.lang.String | *No description.* | +| httpsEnforced | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| id | java.lang.String | *No description.* | +| public | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `apiUrl`Required + +```java +public java.lang.String getApiUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `buildStatus`Required + +```java +public java.lang.String getBuildStatus(); +``` + +- *Type:* java.lang.String + +--- + +##### `custom404`Required + +```java +public IResolvable getCustom404(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `htmlUrl`Required + +```java +public java.lang.String getHtmlUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryId`Required + +```java +public java.lang.Number getRepositoryId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `source`Required + +```java +public RepositoryPagesSourceAOutputReference getSource(); +``` + +- *Type:* RepositoryPagesSourceAOutputReference + +--- + +##### `buildTypeInput`Optional + +```java +public java.lang.String getBuildTypeInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `cnameInput`Optional + +```java +public java.lang.String getCnameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `httpsEnforcedInput`Optional + +```java +public java.lang.Boolean|IResolvable getHttpsEnforcedInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `publicInput`Optional + +```java +public java.lang.Boolean|IResolvable getPublicInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `sourceInput`Optional + +```java +public RepositoryPagesSourceA getSourceInput(); +``` + +- *Type:* RepositoryPagesSourceA + +--- + +##### `buildType`Required + +```java +public java.lang.String getBuildType(); +``` + +- *Type:* java.lang.String + +--- + +##### `cname`Required + +```java +public java.lang.String getCname(); +``` + +- *Type:* java.lang.String + +--- + +##### `httpsEnforced`Required + +```java +public java.lang.Boolean|IResolvable getHttpsEnforced(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `public`Required + +```java +public java.lang.Boolean|IResolvable getPublic(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### RepositoryPagesAConfig + +#### Initializer + +```java +import io.cdktn.providers.github.repository_pages.RepositoryPagesAConfig; + +RepositoryPagesAConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .buildType(java.lang.String) +// .cname(java.lang.String) +// .httpsEnforced(java.lang.Boolean|IResolvable) +// .id(java.lang.String) +// .public(java.lang.Boolean|IResolvable) +// .source(RepositoryPagesSourceA) + .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 | *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 | *No description.* | +| repository | java.lang.String | The repository name to configure GitHub Pages for. | +| buildType | java.lang.String | The type of GitHub Pages site to build. Can be 'legacy' or 'workflow'. | +| cname | java.lang.String | The custom domain for the repository. | +| httpsEnforced | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether the rendered GitHub Pages site will only be served over HTTPS. Requires 'cname' to be set. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#id RepositoryPagesA#id}. | +| public | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether the GitHub Pages site is publicly visible. | +| source | RepositoryPagesSourceA | source block. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The repository name to configure GitHub Pages for. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#repository RepositoryPagesA#repository} + +--- + +##### `buildType`Optional + +```java +public java.lang.String getBuildType(); +``` + +- *Type:* java.lang.String + +The type of GitHub Pages site to build. Can be 'legacy' or 'workflow'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#build_type RepositoryPagesA#build_type} + +--- + +##### `cname`Optional + +```java +public java.lang.String getCname(); +``` + +- *Type:* java.lang.String + +The custom domain for the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#cname RepositoryPagesA#cname} + +--- + +##### `httpsEnforced`Optional + +```java +public java.lang.Boolean|IResolvable getHttpsEnforced(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether the rendered GitHub Pages site will only be served over HTTPS. Requires 'cname' to be set. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#https_enforced RepositoryPagesA#https_enforced} + +--- + +##### `id`Optional + +```java +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/resources/repository_pages#id RepositoryPagesA#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`Optional + +```java +public java.lang.Boolean|IResolvable getPublic(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether the GitHub Pages site is publicly visible. + +If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#public RepositoryPagesA#public} + +--- + +##### `source`Optional + +```java +public RepositoryPagesSourceA getSource(); +``` + +- *Type:* RepositoryPagesSourceA + +source block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#source RepositoryPagesA#source} + +--- + +### RepositoryPagesSourceA + +#### Initializer + +```java +import io.cdktn.providers.github.repository_pages.RepositoryPagesSourceA; + +RepositoryPagesSourceA.builder() + .branch(java.lang.String) +// .path(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| branch | java.lang.String | The repository branch used to publish the site's source files. (i.e. 'main' or 'gh-pages'). | +| path | java.lang.String | The repository directory from which the site publishes (Default: '/'). | + +--- + +##### `branch`Required + +```java +public java.lang.String getBranch(); +``` + +- *Type:* java.lang.String + +The repository branch used to publish the site's source files. (i.e. 'main' or 'gh-pages'). + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#branch RepositoryPagesA#branch} + +--- + +##### `path`Optional + +```java +public java.lang.String getPath(); +``` + +- *Type:* java.lang.String + +The repository directory from which the site publishes (Default: '/'). + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pages#path RepositoryPagesA#path} + +--- + +## Classes + +### RepositoryPagesSourceAOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_pages.RepositoryPagesSourceAOutputReference; + +new RepositoryPagesSourceAOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetPath | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetPath` + +```java +public void resetPath() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| branchInput | java.lang.String | *No description.* | +| pathInput | java.lang.String | *No description.* | +| branch | java.lang.String | *No description.* | +| path | java.lang.String | *No description.* | +| internalValue | RepositoryPagesSourceA | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `branchInput`Optional + +```java +public java.lang.String getBranchInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `pathInput`Optional + +```java +public java.lang.String getPathInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `branch`Required + +```java +public java.lang.String getBranch(); +``` + +- *Type:* java.lang.String + +--- + +##### `path`Required + +```java +public java.lang.String getPath(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public RepositoryPagesSourceA getInternalValue(); +``` + +- *Type:* RepositoryPagesSourceA + +--- + + + diff --git a/docs/repositoryProject.csharp.md b/docs/repositoryProject.csharp.md new file mode 100644 index 000000000..bf27b46d5 --- /dev/null +++ b/docs/repositoryProject.csharp.md @@ -0,0 +1,1011 @@ +# `repositoryProject` Submodule + +## Constructs + +### RepositoryProject + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project github_repository_project}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryProject(Construct Scope, string Id, RepositoryProjectConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | RepositoryProjectConfig | *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:* RepositoryProjectConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetBody | *No description.* | +| ResetEtag | *No description.* | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetBody` + +```csharp +private void ResetBody() +``` + +##### `ResetEtag` + +```csharp +private void ResetEtag() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a RepositoryProject resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryProject.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` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryProject.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryProject.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryProject.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a RepositoryProject resource upon running "cdktn 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 RepositoryProject to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing RepositoryProject that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the RepositoryProject to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Url | string | *No description.* | +| BodyInput | string | *No description.* | +| EtagInput | string | *No description.* | +| IdInput | string | *No description.* | +| NameInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Body | string | *No description.* | +| Etag | string | *No description.* | +| Id | string | *No description.* | +| Name | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Url`Required + +```csharp +public string Url { get; } +``` + +- *Type:* string + +--- + +##### `BodyInput`Optional + +```csharp +public string BodyInput { get; } +``` + +- *Type:* string + +--- + +##### `EtagInput`Optional + +```csharp +public string EtagInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Body`Required + +```csharp +public string Body { get; } +``` + +- *Type:* string + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### RepositoryProjectConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryProjectConfig { + 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 Name, + string Repository, + string Body = null, + string Etag = null, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Name | string | The name of the project. | +| Repository | string | The repository of the project. | +| Body | string | The body of the project. | +| Etag | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project#etag RepositoryProject#etag}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project#id RepositoryProject#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Name`Required + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +The name of the project. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project#name RepositoryProject#name} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The repository of the project. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project#repository RepositoryProject#repository} + +--- + +##### `Body`Optional + +```csharp +public string Body { get; set; } +``` + +- *Type:* string + +The body of the project. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project#body RepositoryProject#body} + +--- + +##### `Etag`Optional + +```csharp +public string Etag { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project#etag RepositoryProject#etag}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project#id RepositoryProject#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. + +--- + + + diff --git a/docs/repositoryProject.java.md b/docs/repositoryProject.java.md new file mode 100644 index 000000000..9cc5b0552 --- /dev/null +++ b/docs/repositoryProject.java.md @@ -0,0 +1,1122 @@ +# `repositoryProject` Submodule + +## Constructs + +### RepositoryProject + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project github_repository_project}. + +#### Initializers + +```java +import io.cdktn.providers.github.repository_project.RepositoryProject; + +RepositoryProject.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .name(java.lang.String) + .repository(java.lang.String) +// .body(java.lang.String) +// .etag(java.lang.String) +// .id(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 | *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 | *No description.* | +| name | java.lang.String | The name of the project. | +| repository | java.lang.String | The repository of the project. | +| body | java.lang.String | The body of the project. | +| etag | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project#etag RepositoryProject#etag}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project#id RepositoryProject#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `name`Required + +- *Type:* java.lang.String + +The name of the project. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project#name RepositoryProject#name} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The repository of the project. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project#repository RepositoryProject#repository} + +--- + +##### `body`Optional + +- *Type:* java.lang.String + +The body of the project. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project#body RepositoryProject#body} + +--- + +##### `etag`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project#etag RepositoryProject#etag}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project#id RepositoryProject#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetBody | *No description.* | +| resetEtag | *No description.* | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetBody` + +```java +public void resetBody() +``` + +##### `resetEtag` + +```java +public void resetEtag() +``` + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a RepositoryProject resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.repository_project.RepositoryProject; + +RepositoryProject.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` + +```java +import io.cdktn.providers.github.repository_project.RepositoryProject; + +RepositoryProject.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.repository_project.RepositoryProject; + +RepositoryProject.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.repository_project.RepositoryProject; + +RepositoryProject.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),RepositoryProject.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a RepositoryProject 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 RepositoryProject to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing RepositoryProject that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project#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 RepositoryProject 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| url | java.lang.String | *No description.* | +| bodyInput | java.lang.String | *No description.* | +| etagInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| body | java.lang.String | *No description.* | +| etag | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `bodyInput`Optional + +```java +public java.lang.String getBodyInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `etagInput`Optional + +```java +public java.lang.String getEtagInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `body`Required + +```java +public java.lang.String getBody(); +``` + +- *Type:* java.lang.String + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### RepositoryProjectConfig + +#### Initializer + +```java +import io.cdktn.providers.github.repository_project.RepositoryProjectConfig; + +RepositoryProjectConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .name(java.lang.String) + .repository(java.lang.String) +// .body(java.lang.String) +// .etag(java.lang.String) +// .id(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 | *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 | *No description.* | +| name | java.lang.String | The name of the project. | +| repository | java.lang.String | The repository of the project. | +| body | java.lang.String | The body of the project. | +| etag | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project#etag RepositoryProject#etag}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project#id RepositoryProject#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +The name of the project. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project#name RepositoryProject#name} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The repository of the project. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project#repository RepositoryProject#repository} + +--- + +##### `body`Optional + +```java +public java.lang.String getBody(); +``` + +- *Type:* java.lang.String + +The body of the project. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project#body RepositoryProject#body} + +--- + +##### `etag`Optional + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_project#etag RepositoryProject#etag}. + +--- + +##### `id`Optional + +```java +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/resources/repository_project#id RepositoryProject#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. + +--- + + + diff --git a/docs/repositoryPullRequest.csharp.md b/docs/repositoryPullRequest.csharp.md new file mode 100644 index 000000000..d514938ba --- /dev/null +++ b/docs/repositoryPullRequest.csharp.md @@ -0,0 +1,1222 @@ +# `repositoryPullRequest` Submodule + +## Constructs + +### RepositoryPullRequest + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request github_repository_pull_request}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryPullRequest(Construct Scope, string Id, RepositoryPullRequestConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | RepositoryPullRequestConfig | *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:* RepositoryPullRequestConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetBody | *No description.* | +| ResetId | *No description.* | +| ResetMaintainerCanModify | *No description.* | +| ResetOwner | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetBody` + +```csharp +private void ResetBody() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetMaintainerCanModify` + +```csharp +private void ResetMaintainerCanModify() +``` + +##### `ResetOwner` + +```csharp +private void ResetOwner() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a RepositoryPullRequest resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryPullRequest.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` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryPullRequest.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryPullRequest.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryPullRequest.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a RepositoryPullRequest resource upon running "cdktn 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 RepositoryPullRequest to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing RepositoryPullRequest that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the RepositoryPullRequest to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| BaseSha | string | *No description.* | +| Draft | Io.Cdktn.IResolvable | *No description.* | +| HeadSha | string | *No description.* | +| Labels | string[] | *No description.* | +| Number | double | *No description.* | +| OpenedAt | double | *No description.* | +| OpenedBy | string | *No description.* | +| State | string | *No description.* | +| UpdatedAt | double | *No description.* | +| BaseRefInput | string | *No description.* | +| BaseRepositoryInput | string | *No description.* | +| BodyInput | string | *No description.* | +| HeadRefInput | string | *No description.* | +| IdInput | string | *No description.* | +| MaintainerCanModifyInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| OwnerInput | string | *No description.* | +| TitleInput | string | *No description.* | +| BaseRef | string | *No description.* | +| BaseRepository | string | *No description.* | +| Body | string | *No description.* | +| HeadRef | string | *No description.* | +| Id | string | *No description.* | +| MaintainerCanModify | bool\|Io.Cdktn.IResolvable | *No description.* | +| Owner | string | *No description.* | +| Title | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `BaseSha`Required + +```csharp +public string BaseSha { get; } +``` + +- *Type:* string + +--- + +##### `Draft`Required + +```csharp +public IResolvable Draft { get; } +``` + +- *Type:* Io.Cdktn.IResolvable + +--- + +##### `HeadSha`Required + +```csharp +public string HeadSha { get; } +``` + +- *Type:* string + +--- + +##### `Labels`Required + +```csharp +public string[] Labels { get; } +``` + +- *Type:* string[] + +--- + +##### `Number`Required + +```csharp +public double Number { get; } +``` + +- *Type:* double + +--- + +##### `OpenedAt`Required + +```csharp +public double OpenedAt { get; } +``` + +- *Type:* double + +--- + +##### `OpenedBy`Required + +```csharp +public string OpenedBy { get; } +``` + +- *Type:* string + +--- + +##### `State`Required + +```csharp +public string State { get; } +``` + +- *Type:* string + +--- + +##### `UpdatedAt`Required + +```csharp +public double UpdatedAt { get; } +``` + +- *Type:* double + +--- + +##### `BaseRefInput`Optional + +```csharp +public string BaseRefInput { get; } +``` + +- *Type:* string + +--- + +##### `BaseRepositoryInput`Optional + +```csharp +public string BaseRepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `BodyInput`Optional + +```csharp +public string BodyInput { get; } +``` + +- *Type:* string + +--- + +##### `HeadRefInput`Optional + +```csharp +public string HeadRefInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `MaintainerCanModifyInput`Optional + +```csharp +public bool|IResolvable MaintainerCanModifyInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `OwnerInput`Optional + +```csharp +public string OwnerInput { get; } +``` + +- *Type:* string + +--- + +##### `TitleInput`Optional + +```csharp +public string TitleInput { get; } +``` + +- *Type:* string + +--- + +##### `BaseRef`Required + +```csharp +public string BaseRef { get; } +``` + +- *Type:* string + +--- + +##### `BaseRepository`Required + +```csharp +public string BaseRepository { get; } +``` + +- *Type:* string + +--- + +##### `Body`Required + +```csharp +public string Body { get; } +``` + +- *Type:* string + +--- + +##### `HeadRef`Required + +```csharp +public string HeadRef { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `MaintainerCanModify`Required + +```csharp +public bool|IResolvable MaintainerCanModify { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Owner`Required + +```csharp +public string Owner { get; } +``` + +- *Type:* string + +--- + +##### `Title`Required + +```csharp +public string Title { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### RepositoryPullRequestConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryPullRequestConfig { + 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 BaseRef, + string BaseRepository, + string HeadRef, + string Title, + string Body = null, + string Id = null, + bool|IResolvable MaintainerCanModify = null, + string Owner = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| BaseRef | string | Name of the branch serving as the base of the Pull Request. | +| BaseRepository | string | Name of the base repository to retrieve the Pull Requests from. | +| HeadRef | string | Name of the branch serving as the head of the Pull Request. | +| Title | string | The title of the Pull Request. | +| Body | string | Body of the Pull Request. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#id RepositoryPullRequest#id}. | +| MaintainerCanModify | bool\|Io.Cdktn.IResolvable | Controls whether the base repository maintainers can modify the Pull Request. Default: 'false'. | +| Owner | string | Owner of the repository. If not provided, the provider's default owner is used. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `BaseRef`Required + +```csharp +public string BaseRef { get; set; } +``` + +- *Type:* string + +Name of the branch serving as the base of the Pull Request. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#base_ref RepositoryPullRequest#base_ref} + +--- + +##### `BaseRepository`Required + +```csharp +public string BaseRepository { get; set; } +``` + +- *Type:* string + +Name of the base repository to retrieve the Pull Requests from. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#base_repository RepositoryPullRequest#base_repository} + +--- + +##### `HeadRef`Required + +```csharp +public string HeadRef { get; set; } +``` + +- *Type:* string + +Name of the branch serving as the head of the Pull Request. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#head_ref RepositoryPullRequest#head_ref} + +--- + +##### `Title`Required + +```csharp +public string Title { get; set; } +``` + +- *Type:* string + +The title of the Pull Request. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#title RepositoryPullRequest#title} + +--- + +##### `Body`Optional + +```csharp +public string Body { get; set; } +``` + +- *Type:* string + +Body of the Pull Request. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#body RepositoryPullRequest#body} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#id RepositoryPullRequest#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. + +--- + +##### `MaintainerCanModify`Optional + +```csharp +public bool|IResolvable MaintainerCanModify { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Controls whether the base repository maintainers can modify the Pull Request. Default: 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#maintainer_can_modify RepositoryPullRequest#maintainer_can_modify} + +--- + +##### `Owner`Optional + +```csharp +public string Owner { get; set; } +``` + +- *Type:* string + +Owner of the repository. If not provided, the provider's default owner is used. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#owner RepositoryPullRequest#owner} + +--- + + + diff --git a/docs/repositoryPullRequest.java.md b/docs/repositoryPullRequest.java.md new file mode 100644 index 000000000..7a07b6d11 --- /dev/null +++ b/docs/repositoryPullRequest.java.md @@ -0,0 +1,1371 @@ +# `repositoryPullRequest` Submodule + +## Constructs + +### RepositoryPullRequest + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request github_repository_pull_request}. + +#### Initializers + +```java +import io.cdktn.providers.github.repository_pull_request.RepositoryPullRequest; + +RepositoryPullRequest.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .baseRef(java.lang.String) + .baseRepository(java.lang.String) + .headRef(java.lang.String) + .title(java.lang.String) +// .body(java.lang.String) +// .id(java.lang.String) +// .maintainerCanModify(java.lang.Boolean|IResolvable) +// .owner(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 | *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 | *No description.* | +| baseRef | java.lang.String | Name of the branch serving as the base of the Pull Request. | +| baseRepository | java.lang.String | Name of the base repository to retrieve the Pull Requests from. | +| headRef | java.lang.String | Name of the branch serving as the head of the Pull Request. | +| title | java.lang.String | The title of the Pull Request. | +| body | java.lang.String | Body of the Pull Request. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#id RepositoryPullRequest#id}. | +| maintainerCanModify | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Controls whether the base repository maintainers can modify the Pull Request. Default: 'false'. | +| owner | java.lang.String | Owner of the repository. If not provided, the provider's default owner is used. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `baseRef`Required + +- *Type:* java.lang.String + +Name of the branch serving as the base of the Pull Request. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#base_ref RepositoryPullRequest#base_ref} + +--- + +##### `baseRepository`Required + +- *Type:* java.lang.String + +Name of the base repository to retrieve the Pull Requests from. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#base_repository RepositoryPullRequest#base_repository} + +--- + +##### `headRef`Required + +- *Type:* java.lang.String + +Name of the branch serving as the head of the Pull Request. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#head_ref RepositoryPullRequest#head_ref} + +--- + +##### `title`Required + +- *Type:* java.lang.String + +The title of the Pull Request. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#title RepositoryPullRequest#title} + +--- + +##### `body`Optional + +- *Type:* java.lang.String + +Body of the Pull Request. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#body RepositoryPullRequest#body} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#id RepositoryPullRequest#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. + +--- + +##### `maintainerCanModify`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Controls whether the base repository maintainers can modify the Pull Request. Default: 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#maintainer_can_modify RepositoryPullRequest#maintainer_can_modify} + +--- + +##### `owner`Optional + +- *Type:* java.lang.String + +Owner of the repository. If not provided, the provider's default owner is used. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#owner RepositoryPullRequest#owner} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetBody | *No description.* | +| resetId | *No description.* | +| resetMaintainerCanModify | *No description.* | +| resetOwner | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetBody` + +```java +public void resetBody() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetMaintainerCanModify` + +```java +public void resetMaintainerCanModify() +``` + +##### `resetOwner` + +```java +public void resetOwner() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a RepositoryPullRequest resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.repository_pull_request.RepositoryPullRequest; + +RepositoryPullRequest.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` + +```java +import io.cdktn.providers.github.repository_pull_request.RepositoryPullRequest; + +RepositoryPullRequest.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.repository_pull_request.RepositoryPullRequest; + +RepositoryPullRequest.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.repository_pull_request.RepositoryPullRequest; + +RepositoryPullRequest.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),RepositoryPullRequest.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a RepositoryPullRequest 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 RepositoryPullRequest to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing RepositoryPullRequest that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#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 RepositoryPullRequest 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| baseSha | java.lang.String | *No description.* | +| draft | io.cdktn.cdktn.IResolvable | *No description.* | +| headSha | java.lang.String | *No description.* | +| labels | java.util.List | *No description.* | +| number | java.lang.Number | *No description.* | +| openedAt | java.lang.Number | *No description.* | +| openedBy | java.lang.String | *No description.* | +| state | java.lang.String | *No description.* | +| updatedAt | java.lang.Number | *No description.* | +| baseRefInput | java.lang.String | *No description.* | +| baseRepositoryInput | java.lang.String | *No description.* | +| bodyInput | java.lang.String | *No description.* | +| headRefInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| maintainerCanModifyInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| ownerInput | java.lang.String | *No description.* | +| titleInput | java.lang.String | *No description.* | +| baseRef | java.lang.String | *No description.* | +| baseRepository | java.lang.String | *No description.* | +| body | java.lang.String | *No description.* | +| headRef | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| maintainerCanModify | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| owner | java.lang.String | *No description.* | +| title | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `baseSha`Required + +```java +public java.lang.String getBaseSha(); +``` + +- *Type:* java.lang.String + +--- + +##### `draft`Required + +```java +public IResolvable getDraft(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable + +--- + +##### `headSha`Required + +```java +public java.lang.String getHeadSha(); +``` + +- *Type:* java.lang.String + +--- + +##### `labels`Required + +```java +public java.util.List getLabels(); +``` + +- *Type:* java.util.List + +--- + +##### `number`Required + +```java +public java.lang.Number getNumber(); +``` + +- *Type:* java.lang.Number + +--- + +##### `openedAt`Required + +```java +public java.lang.Number getOpenedAt(); +``` + +- *Type:* java.lang.Number + +--- + +##### `openedBy`Required + +```java +public java.lang.String getOpenedBy(); +``` + +- *Type:* java.lang.String + +--- + +##### `state`Required + +```java +public java.lang.String getState(); +``` + +- *Type:* java.lang.String + +--- + +##### `updatedAt`Required + +```java +public java.lang.Number getUpdatedAt(); +``` + +- *Type:* java.lang.Number + +--- + +##### `baseRefInput`Optional + +```java +public java.lang.String getBaseRefInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `baseRepositoryInput`Optional + +```java +public java.lang.String getBaseRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `bodyInput`Optional + +```java +public java.lang.String getBodyInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `headRefInput`Optional + +```java +public java.lang.String getHeadRefInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `maintainerCanModifyInput`Optional + +```java +public java.lang.Boolean|IResolvable getMaintainerCanModifyInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `ownerInput`Optional + +```java +public java.lang.String getOwnerInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `titleInput`Optional + +```java +public java.lang.String getTitleInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `baseRef`Required + +```java +public java.lang.String getBaseRef(); +``` + +- *Type:* java.lang.String + +--- + +##### `baseRepository`Required + +```java +public java.lang.String getBaseRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `body`Required + +```java +public java.lang.String getBody(); +``` + +- *Type:* java.lang.String + +--- + +##### `headRef`Required + +```java +public java.lang.String getHeadRef(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `maintainerCanModify`Required + +```java +public java.lang.Boolean|IResolvable getMaintainerCanModify(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `owner`Required + +```java +public java.lang.String getOwner(); +``` + +- *Type:* java.lang.String + +--- + +##### `title`Required + +```java +public java.lang.String getTitle(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### RepositoryPullRequestConfig + +#### Initializer + +```java +import io.cdktn.providers.github.repository_pull_request.RepositoryPullRequestConfig; + +RepositoryPullRequestConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .baseRef(java.lang.String) + .baseRepository(java.lang.String) + .headRef(java.lang.String) + .title(java.lang.String) +// .body(java.lang.String) +// .id(java.lang.String) +// .maintainerCanModify(java.lang.Boolean|IResolvable) +// .owner(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 | *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 | *No description.* | +| baseRef | java.lang.String | Name of the branch serving as the base of the Pull Request. | +| baseRepository | java.lang.String | Name of the base repository to retrieve the Pull Requests from. | +| headRef | java.lang.String | Name of the branch serving as the head of the Pull Request. | +| title | java.lang.String | The title of the Pull Request. | +| body | java.lang.String | Body of the Pull Request. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#id RepositoryPullRequest#id}. | +| maintainerCanModify | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Controls whether the base repository maintainers can modify the Pull Request. Default: 'false'. | +| owner | java.lang.String | Owner of the repository. If not provided, the provider's default owner is used. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `baseRef`Required + +```java +public java.lang.String getBaseRef(); +``` + +- *Type:* java.lang.String + +Name of the branch serving as the base of the Pull Request. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#base_ref RepositoryPullRequest#base_ref} + +--- + +##### `baseRepository`Required + +```java +public java.lang.String getBaseRepository(); +``` + +- *Type:* java.lang.String + +Name of the base repository to retrieve the Pull Requests from. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#base_repository RepositoryPullRequest#base_repository} + +--- + +##### `headRef`Required + +```java +public java.lang.String getHeadRef(); +``` + +- *Type:* java.lang.String + +Name of the branch serving as the head of the Pull Request. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#head_ref RepositoryPullRequest#head_ref} + +--- + +##### `title`Required + +```java +public java.lang.String getTitle(); +``` + +- *Type:* java.lang.String + +The title of the Pull Request. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#title RepositoryPullRequest#title} + +--- + +##### `body`Optional + +```java +public java.lang.String getBody(); +``` + +- *Type:* java.lang.String + +Body of the Pull Request. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#body RepositoryPullRequest#body} + +--- + +##### `id`Optional + +```java +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/resources/repository_pull_request#id RepositoryPullRequest#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. + +--- + +##### `maintainerCanModify`Optional + +```java +public java.lang.Boolean|IResolvable getMaintainerCanModify(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Controls whether the base repository maintainers can modify the Pull Request. Default: 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#maintainer_can_modify RepositoryPullRequest#maintainer_can_modify} + +--- + +##### `owner`Optional + +```java +public java.lang.String getOwner(); +``` + +- *Type:* java.lang.String + +Owner of the repository. If not provided, the provider's default owner is used. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_pull_request#owner RepositoryPullRequest#owner} + +--- + + + diff --git a/docs/repositoryRuleset.csharp.md b/docs/repositoryRuleset.csharp.md new file mode 100644 index 000000000..3ab88dfc7 --- /dev/null +++ b/docs/repositoryRuleset.csharp.md @@ -0,0 +1,11847 @@ +# `repositoryRuleset` Submodule + +## Constructs + +### RepositoryRuleset + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset github_repository_ruleset}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRuleset(Construct Scope, string Id, RepositoryRulesetConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | RepositoryRulesetConfig | *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:* RepositoryRulesetConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| PutBypassActors | *No description.* | +| PutConditions | *No description.* | +| PutRules | *No description.* | +| ResetBypassActors | *No description.* | +| ResetConditions | *No description.* | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `PutBypassActors` + +```csharp +private void PutBypassActors(IResolvable|RepositoryRulesetBypassActors[] Value) +``` + +###### `Value`Required + +- *Type:* Io.Cdktn.IResolvable|RepositoryRulesetBypassActors[] + +--- + +##### `PutConditions` + +```csharp +private void PutConditions(RepositoryRulesetConditions Value) +``` + +###### `Value`Required + +- *Type:* RepositoryRulesetConditions + +--- + +##### `PutRules` + +```csharp +private void PutRules(RepositoryRulesetRules Value) +``` + +###### `Value`Required + +- *Type:* RepositoryRulesetRules + +--- + +##### `ResetBypassActors` + +```csharp +private void ResetBypassActors() +``` + +##### `ResetConditions` + +```csharp +private void ResetConditions() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a RepositoryRuleset resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryRuleset.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` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryRuleset.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryRuleset.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryRuleset.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a RepositoryRuleset resource upon running "cdktn 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 RepositoryRuleset to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing RepositoryRuleset that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the RepositoryRuleset to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| BypassActors | RepositoryRulesetBypassActorsList | *No description.* | +| Conditions | RepositoryRulesetConditionsOutputReference | *No description.* | +| Etag | string | *No description.* | +| NodeId | string | *No description.* | +| Rules | RepositoryRulesetRulesOutputReference | *No description.* | +| RulesetId | double | *No description.* | +| BypassActorsInput | Io.Cdktn.IResolvable\|RepositoryRulesetBypassActors[] | *No description.* | +| ConditionsInput | RepositoryRulesetConditions | *No description.* | +| EnforcementInput | string | *No description.* | +| IdInput | string | *No description.* | +| NameInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| RulesInput | RepositoryRulesetRules | *No description.* | +| TargetInput | string | *No description.* | +| Enforcement | string | *No description.* | +| Id | string | *No description.* | +| Name | string | *No description.* | +| Repository | string | *No description.* | +| Target | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `BypassActors`Required + +```csharp +public RepositoryRulesetBypassActorsList BypassActors { get; } +``` + +- *Type:* RepositoryRulesetBypassActorsList + +--- + +##### `Conditions`Required + +```csharp +public RepositoryRulesetConditionsOutputReference Conditions { get; } +``` + +- *Type:* RepositoryRulesetConditionsOutputReference + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `NodeId`Required + +```csharp +public string NodeId { get; } +``` + +- *Type:* string + +--- + +##### `Rules`Required + +```csharp +public RepositoryRulesetRulesOutputReference Rules { get; } +``` + +- *Type:* RepositoryRulesetRulesOutputReference + +--- + +##### `RulesetId`Required + +```csharp +public double RulesetId { get; } +``` + +- *Type:* double + +--- + +##### `BypassActorsInput`Optional + +```csharp +public IResolvable|RepositoryRulesetBypassActors[] BypassActorsInput { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryRulesetBypassActors[] + +--- + +##### `ConditionsInput`Optional + +```csharp +public RepositoryRulesetConditions ConditionsInput { get; } +``` + +- *Type:* RepositoryRulesetConditions + +--- + +##### `EnforcementInput`Optional + +```csharp +public string EnforcementInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `RulesInput`Optional + +```csharp +public RepositoryRulesetRules RulesInput { get; } +``` + +- *Type:* RepositoryRulesetRules + +--- + +##### `TargetInput`Optional + +```csharp +public string TargetInput { get; } +``` + +- *Type:* string + +--- + +##### `Enforcement`Required + +```csharp +public string Enforcement { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `Target`Required + +```csharp +public string Target { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### RepositoryRulesetBypassActors + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetBypassActors { + string ActorType, + string BypassMode, + double ActorId = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ActorType | string | The type of actor that can bypass a ruleset. See https://docs.github.com/en/rest/repos/rules for more information. | +| BypassMode | string | When the specified actor can bypass the ruleset. | +| ActorId | double | The ID of the actor that can bypass a ruleset. | + +--- + +##### `ActorType`Required + +```csharp +public string ActorType { get; set; } +``` + +- *Type:* string + +The type of actor that can bypass a ruleset. See https://docs.github.com/en/rest/repos/rules for more information. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#actor_type RepositoryRuleset#actor_type} + +--- + +##### `BypassMode`Required + +```csharp +public string BypassMode { get; set; } +``` + +- *Type:* string + +When the specified actor can bypass the ruleset. + +pull_request means that an actor can only bypass rules on pull requests. Can be one of: `always`, `pull_request`, `exempt`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#bypass_mode RepositoryRuleset#bypass_mode} + +--- + +##### `ActorId`Optional + +```csharp +public double ActorId { get; set; } +``` + +- *Type:* double + +The ID of the actor that can bypass a ruleset. + +When `actor_type` is `OrganizationAdmin`, this should be set to `1`. Some resources such as DeployKey do not have an ID and this should be omitted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#actor_id RepositoryRuleset#actor_id} + +--- + +### RepositoryRulesetConditions + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetConditions { + RepositoryRulesetConditionsRefName RefName +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| RefName | RepositoryRulesetConditionsRefName | ref_name block. | + +--- + +##### `RefName`Required + +```csharp +public RepositoryRulesetConditionsRefName RefName { get; set; } +``` + +- *Type:* RepositoryRulesetConditionsRefName + +ref_name block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#ref_name RepositoryRuleset#ref_name} + +--- + +### RepositoryRulesetConditionsRefName + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetConditionsRefName { + string[] Exclude, + string[] Include +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Exclude | string[] | Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. | +| Include | string[] | Array of ref names or patterns to include. | + +--- + +##### `Exclude`Required + +```csharp +public string[] Exclude { get; set; } +``` + +- *Type:* string[] + +Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#exclude RepositoryRuleset#exclude} + +--- + +##### `Include`Required + +```csharp +public string[] Include { get; set; } +``` + +- *Type:* string[] + +Array of ref names or patterns to include. + +One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#include RepositoryRuleset#include} + +--- + +### RepositoryRulesetConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetConfig { + 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 Enforcement, + string Name, + string Repository, + RepositoryRulesetRules Rules, + string Target, + IResolvable|RepositoryRulesetBypassActors[] BypassActors = null, + RepositoryRulesetConditions Conditions = null, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Enforcement | string | Possible values for Enforcement are `disabled`, `active`, `evaluate`. Note: `evaluate` is currently only supported for owners of type `organization`. | +| Name | string | The name of the ruleset. | +| Repository | string | Name of the repository to apply ruleset to. | +| Rules | RepositoryRulesetRules | rules block. | +| Target | string | Possible values are branch, push and tag. | +| BypassActors | Io.Cdktn.IResolvable\|RepositoryRulesetBypassActors[] | bypass_actors block. | +| Conditions | RepositoryRulesetConditions | conditions block. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#id RepositoryRuleset#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Enforcement`Required + +```csharp +public string Enforcement { get; set; } +``` + +- *Type:* string + +Possible values for Enforcement are `disabled`, `active`, `evaluate`. Note: `evaluate` is currently only supported for owners of type `organization`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#enforcement RepositoryRuleset#enforcement} + +--- + +##### `Name`Required + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +The name of the ruleset. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#name RepositoryRuleset#name} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +Name of the repository to apply ruleset to. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#repository RepositoryRuleset#repository} + +--- + +##### `Rules`Required + +```csharp +public RepositoryRulesetRules Rules { get; set; } +``` + +- *Type:* RepositoryRulesetRules + +rules block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#rules RepositoryRuleset#rules} + +--- + +##### `Target`Required + +```csharp +public string Target { get; set; } +``` + +- *Type:* string + +Possible values are branch, push and tag. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#target RepositoryRuleset#target} + +--- + +##### `BypassActors`Optional + +```csharp +public IResolvable|RepositoryRulesetBypassActors[] BypassActors { get; set; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryRulesetBypassActors[] + +bypass_actors block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#bypass_actors RepositoryRuleset#bypass_actors} + +--- + +##### `Conditions`Optional + +```csharp +public RepositoryRulesetConditions Conditions { get; set; } +``` + +- *Type:* RepositoryRulesetConditions + +conditions block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#conditions RepositoryRuleset#conditions} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#id RepositoryRuleset#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. + +--- + +### RepositoryRulesetRules + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRules { + RepositoryRulesetRulesBranchNamePattern BranchNamePattern = null, + RepositoryRulesetRulesCommitAuthorEmailPattern CommitAuthorEmailPattern = null, + RepositoryRulesetRulesCommitMessagePattern CommitMessagePattern = null, + RepositoryRulesetRulesCommitterEmailPattern CommitterEmailPattern = null, + RepositoryRulesetRulesCopilotCodeReview CopilotCodeReview = null, + bool|IResolvable Creation = null, + bool|IResolvable Deletion = null, + RepositoryRulesetRulesFileExtensionRestriction FileExtensionRestriction = null, + RepositoryRulesetRulesFilePathRestriction FilePathRestriction = null, + RepositoryRulesetRulesMaxFilePathLength MaxFilePathLength = null, + RepositoryRulesetRulesMaxFileSize MaxFileSize = null, + RepositoryRulesetRulesMergeQueue MergeQueue = null, + bool|IResolvable NonFastForward = null, + RepositoryRulesetRulesPullRequest PullRequest = null, + RepositoryRulesetRulesRequiredCodeScanning RequiredCodeScanning = null, + RepositoryRulesetRulesRequiredDeployments RequiredDeployments = null, + bool|IResolvable RequiredLinearHistory = null, + bool|IResolvable RequiredSignatures = null, + RepositoryRulesetRulesRequiredStatusChecks RequiredStatusChecks = null, + RepositoryRulesetRulesTagNamePattern TagNamePattern = null, + bool|IResolvable Update = null, + bool|IResolvable UpdateAllowsFetchAndMerge = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| BranchNamePattern | RepositoryRulesetRulesBranchNamePattern | branch_name_pattern block. | +| CommitAuthorEmailPattern | RepositoryRulesetRulesCommitAuthorEmailPattern | commit_author_email_pattern block. | +| CommitMessagePattern | RepositoryRulesetRulesCommitMessagePattern | commit_message_pattern block. | +| CommitterEmailPattern | RepositoryRulesetRulesCommitterEmailPattern | committer_email_pattern block. | +| CopilotCodeReview | RepositoryRulesetRulesCopilotCodeReview | copilot_code_review block. | +| Creation | bool\|Io.Cdktn.IResolvable | Only allow users with bypass permission to create matching refs. | +| Deletion | bool\|Io.Cdktn.IResolvable | Only allow users with bypass permissions to delete matching refs. | +| FileExtensionRestriction | RepositoryRulesetRulesFileExtensionRestriction | file_extension_restriction block. | +| FilePathRestriction | RepositoryRulesetRulesFilePathRestriction | file_path_restriction block. | +| MaxFilePathLength | RepositoryRulesetRulesMaxFilePathLength | max_file_path_length block. | +| MaxFileSize | RepositoryRulesetRulesMaxFileSize | max_file_size block. | +| MergeQueue | RepositoryRulesetRulesMergeQueue | merge_queue block. | +| NonFastForward | bool\|Io.Cdktn.IResolvable | Prevent users with push access from force pushing to branches. | +| PullRequest | RepositoryRulesetRulesPullRequest | pull_request block. | +| RequiredCodeScanning | RepositoryRulesetRulesRequiredCodeScanning | required_code_scanning block. | +| RequiredDeployments | RepositoryRulesetRulesRequiredDeployments | required_deployments block. | +| RequiredLinearHistory | bool\|Io.Cdktn.IResolvable | Prevent merge commits from being pushed to matching branches. | +| RequiredSignatures | bool\|Io.Cdktn.IResolvable | Commits pushed to matching branches must have verified signatures. | +| RequiredStatusChecks | RepositoryRulesetRulesRequiredStatusChecks | required_status_checks block. | +| TagNamePattern | RepositoryRulesetRulesTagNamePattern | tag_name_pattern block. | +| Update | bool\|Io.Cdktn.IResolvable | Only allow users with bypass permission to update matching refs. | +| UpdateAllowsFetchAndMerge | bool\|Io.Cdktn.IResolvable | Branch can pull changes from its upstream repository. | + +--- + +##### `BranchNamePattern`Optional + +```csharp +public RepositoryRulesetRulesBranchNamePattern BranchNamePattern { get; set; } +``` + +- *Type:* RepositoryRulesetRulesBranchNamePattern + +branch_name_pattern block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#branch_name_pattern RepositoryRuleset#branch_name_pattern} + +--- + +##### `CommitAuthorEmailPattern`Optional + +```csharp +public RepositoryRulesetRulesCommitAuthorEmailPattern CommitAuthorEmailPattern { get; set; } +``` + +- *Type:* RepositoryRulesetRulesCommitAuthorEmailPattern + +commit_author_email_pattern block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#commit_author_email_pattern RepositoryRuleset#commit_author_email_pattern} + +--- + +##### `CommitMessagePattern`Optional + +```csharp +public RepositoryRulesetRulesCommitMessagePattern CommitMessagePattern { get; set; } +``` + +- *Type:* RepositoryRulesetRulesCommitMessagePattern + +commit_message_pattern block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#commit_message_pattern RepositoryRuleset#commit_message_pattern} + +--- + +##### `CommitterEmailPattern`Optional + +```csharp +public RepositoryRulesetRulesCommitterEmailPattern CommitterEmailPattern { get; set; } +``` + +- *Type:* RepositoryRulesetRulesCommitterEmailPattern + +committer_email_pattern block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#committer_email_pattern RepositoryRuleset#committer_email_pattern} + +--- + +##### `CopilotCodeReview`Optional + +```csharp +public RepositoryRulesetRulesCopilotCodeReview CopilotCodeReview { get; set; } +``` + +- *Type:* RepositoryRulesetRulesCopilotCodeReview + +copilot_code_review block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#copilot_code_review RepositoryRuleset#copilot_code_review} + +--- + +##### `Creation`Optional + +```csharp +public bool|IResolvable Creation { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Only allow users with bypass permission to create matching refs. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#creation RepositoryRuleset#creation} + +--- + +##### `Deletion`Optional + +```csharp +public bool|IResolvable Deletion { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Only allow users with bypass permissions to delete matching refs. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#deletion RepositoryRuleset#deletion} + +--- + +##### `FileExtensionRestriction`Optional + +```csharp +public RepositoryRulesetRulesFileExtensionRestriction FileExtensionRestriction { get; set; } +``` + +- *Type:* RepositoryRulesetRulesFileExtensionRestriction + +file_extension_restriction block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#file_extension_restriction RepositoryRuleset#file_extension_restriction} + +--- + +##### `FilePathRestriction`Optional + +```csharp +public RepositoryRulesetRulesFilePathRestriction FilePathRestriction { get; set; } +``` + +- *Type:* RepositoryRulesetRulesFilePathRestriction + +file_path_restriction block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#file_path_restriction RepositoryRuleset#file_path_restriction} + +--- + +##### `MaxFilePathLength`Optional + +```csharp +public RepositoryRulesetRulesMaxFilePathLength MaxFilePathLength { get; set; } +``` + +- *Type:* RepositoryRulesetRulesMaxFilePathLength + +max_file_path_length block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#max_file_path_length RepositoryRuleset#max_file_path_length} + +--- + +##### `MaxFileSize`Optional + +```csharp +public RepositoryRulesetRulesMaxFileSize MaxFileSize { get; set; } +``` + +- *Type:* RepositoryRulesetRulesMaxFileSize + +max_file_size block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#max_file_size RepositoryRuleset#max_file_size} + +--- + +##### `MergeQueue`Optional + +```csharp +public RepositoryRulesetRulesMergeQueue MergeQueue { get; set; } +``` + +- *Type:* RepositoryRulesetRulesMergeQueue + +merge_queue block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#merge_queue RepositoryRuleset#merge_queue} + +--- + +##### `NonFastForward`Optional + +```csharp +public bool|IResolvable NonFastForward { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Prevent users with push access from force pushing to branches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#non_fast_forward RepositoryRuleset#non_fast_forward} + +--- + +##### `PullRequest`Optional + +```csharp +public RepositoryRulesetRulesPullRequest PullRequest { get; set; } +``` + +- *Type:* RepositoryRulesetRulesPullRequest + +pull_request block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#pull_request RepositoryRuleset#pull_request} + +--- + +##### `RequiredCodeScanning`Optional + +```csharp +public RepositoryRulesetRulesRequiredCodeScanning RequiredCodeScanning { get; set; } +``` + +- *Type:* RepositoryRulesetRulesRequiredCodeScanning + +required_code_scanning block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#required_code_scanning RepositoryRuleset#required_code_scanning} + +--- + +##### `RequiredDeployments`Optional + +```csharp +public RepositoryRulesetRulesRequiredDeployments RequiredDeployments { get; set; } +``` + +- *Type:* RepositoryRulesetRulesRequiredDeployments + +required_deployments block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#required_deployments RepositoryRuleset#required_deployments} + +--- + +##### `RequiredLinearHistory`Optional + +```csharp +public bool|IResolvable RequiredLinearHistory { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Prevent merge commits from being pushed to matching branches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#required_linear_history RepositoryRuleset#required_linear_history} + +--- + +##### `RequiredSignatures`Optional + +```csharp +public bool|IResolvable RequiredSignatures { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Commits pushed to matching branches must have verified signatures. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#required_signatures RepositoryRuleset#required_signatures} + +--- + +##### `RequiredStatusChecks`Optional + +```csharp +public RepositoryRulesetRulesRequiredStatusChecks RequiredStatusChecks { get; set; } +``` + +- *Type:* RepositoryRulesetRulesRequiredStatusChecks + +required_status_checks block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#required_status_checks RepositoryRuleset#required_status_checks} + +--- + +##### `TagNamePattern`Optional + +```csharp +public RepositoryRulesetRulesTagNamePattern TagNamePattern { get; set; } +``` + +- *Type:* RepositoryRulesetRulesTagNamePattern + +tag_name_pattern block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#tag_name_pattern RepositoryRuleset#tag_name_pattern} + +--- + +##### `Update`Optional + +```csharp +public bool|IResolvable Update { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Only allow users with bypass permission to update matching refs. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#update RepositoryRuleset#update} + +--- + +##### `UpdateAllowsFetchAndMerge`Optional + +```csharp +public bool|IResolvable UpdateAllowsFetchAndMerge { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Branch can pull changes from its upstream repository. + +This is only applicable to forked repositories. Requires `update` to be set to `true`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#update_allows_fetch_and_merge RepositoryRuleset#update_allows_fetch_and_merge} + +--- + +### RepositoryRulesetRulesBranchNamePattern + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesBranchNamePattern { + string Operator, + string Pattern, + string Name = null, + bool|IResolvable Negate = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Operator | string | The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. | +| Pattern | string | The pattern to match with. | +| Name | string | How this rule will appear to users. | +| Negate | bool\|Io.Cdktn.IResolvable | If true, the rule will fail if the pattern matches. | + +--- + +##### `Operator`Required + +```csharp +public string Operator { get; set; } +``` + +- *Type:* string + +The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#operator RepositoryRuleset#operator} + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; set; } +``` + +- *Type:* string + +The pattern to match with. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#pattern RepositoryRuleset#pattern} + +--- + +##### `Name`Optional + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +How this rule will appear to users. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#name RepositoryRuleset#name} + +--- + +##### `Negate`Optional + +```csharp +public bool|IResolvable Negate { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +If true, the rule will fail if the pattern matches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#negate RepositoryRuleset#negate} + +--- + +### RepositoryRulesetRulesCommitAuthorEmailPattern + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesCommitAuthorEmailPattern { + string Operator, + string Pattern, + string Name = null, + bool|IResolvable Negate = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Operator | string | The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. | +| Pattern | string | The pattern to match with. | +| Name | string | How this rule will appear to users. | +| Negate | bool\|Io.Cdktn.IResolvable | If true, the rule will fail if the pattern matches. | + +--- + +##### `Operator`Required + +```csharp +public string Operator { get; set; } +``` + +- *Type:* string + +The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#operator RepositoryRuleset#operator} + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; set; } +``` + +- *Type:* string + +The pattern to match with. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#pattern RepositoryRuleset#pattern} + +--- + +##### `Name`Optional + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +How this rule will appear to users. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#name RepositoryRuleset#name} + +--- + +##### `Negate`Optional + +```csharp +public bool|IResolvable Negate { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +If true, the rule will fail if the pattern matches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#negate RepositoryRuleset#negate} + +--- + +### RepositoryRulesetRulesCommitMessagePattern + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesCommitMessagePattern { + string Operator, + string Pattern, + string Name = null, + bool|IResolvable Negate = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Operator | string | The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. | +| Pattern | string | The pattern to match with. | +| Name | string | How this rule will appear to users. | +| Negate | bool\|Io.Cdktn.IResolvable | If true, the rule will fail if the pattern matches. | + +--- + +##### `Operator`Required + +```csharp +public string Operator { get; set; } +``` + +- *Type:* string + +The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#operator RepositoryRuleset#operator} + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; set; } +``` + +- *Type:* string + +The pattern to match with. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#pattern RepositoryRuleset#pattern} + +--- + +##### `Name`Optional + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +How this rule will appear to users. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#name RepositoryRuleset#name} + +--- + +##### `Negate`Optional + +```csharp +public bool|IResolvable Negate { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +If true, the rule will fail if the pattern matches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#negate RepositoryRuleset#negate} + +--- + +### RepositoryRulesetRulesCommitterEmailPattern + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesCommitterEmailPattern { + string Operator, + string Pattern, + string Name = null, + bool|IResolvable Negate = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Operator | string | The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. | +| Pattern | string | The pattern to match with. | +| Name | string | How this rule will appear to users. | +| Negate | bool\|Io.Cdktn.IResolvable | If true, the rule will fail if the pattern matches. | + +--- + +##### `Operator`Required + +```csharp +public string Operator { get; set; } +``` + +- *Type:* string + +The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#operator RepositoryRuleset#operator} + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; set; } +``` + +- *Type:* string + +The pattern to match with. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#pattern RepositoryRuleset#pattern} + +--- + +##### `Name`Optional + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +How this rule will appear to users. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#name RepositoryRuleset#name} + +--- + +##### `Negate`Optional + +```csharp +public bool|IResolvable Negate { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +If true, the rule will fail if the pattern matches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#negate RepositoryRuleset#negate} + +--- + +### RepositoryRulesetRulesCopilotCodeReview + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesCopilotCodeReview { + bool|IResolvable ReviewDraftPullRequests = null, + bool|IResolvable ReviewOnPush = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ReviewDraftPullRequests | bool\|Io.Cdktn.IResolvable | Copilot automatically reviews draft pull requests before they are marked as ready for review. Defaults to `false`. | +| ReviewOnPush | bool\|Io.Cdktn.IResolvable | Copilot automatically reviews each new push to the pull request. Defaults to `false`. | + +--- + +##### `ReviewDraftPullRequests`Optional + +```csharp +public bool|IResolvable ReviewDraftPullRequests { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Copilot automatically reviews draft pull requests before they are marked as ready for review. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#review_draft_pull_requests RepositoryRuleset#review_draft_pull_requests} + +--- + +##### `ReviewOnPush`Optional + +```csharp +public bool|IResolvable ReviewOnPush { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Copilot automatically reviews each new push to the pull request. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#review_on_push RepositoryRuleset#review_on_push} + +--- + +### RepositoryRulesetRulesFileExtensionRestriction + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesFileExtensionRestriction { + string[] RestrictedFileExtensions +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| RestrictedFileExtensions | string[] | A list of file extensions. | + +--- + +##### `RestrictedFileExtensions`Required + +```csharp +public string[] RestrictedFileExtensions { get; set; } +``` + +- *Type:* string[] + +A list of file extensions. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#restricted_file_extensions RepositoryRuleset#restricted_file_extensions} + +--- + +### RepositoryRulesetRulesFilePathRestriction + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesFilePathRestriction { + string[] RestrictedFilePaths +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| RestrictedFilePaths | string[] | The file paths that are restricted from being pushed to the commit graph. | + +--- + +##### `RestrictedFilePaths`Required + +```csharp +public string[] RestrictedFilePaths { get; set; } +``` + +- *Type:* string[] + +The file paths that are restricted from being pushed to the commit graph. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#restricted_file_paths RepositoryRuleset#restricted_file_paths} + +--- + +### RepositoryRulesetRulesMaxFilePathLength + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesMaxFilePathLength { + double MaxFilePathLength +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| MaxFilePathLength | double | The maximum allowed length of a file path. | + +--- + +##### `MaxFilePathLength`Required + +```csharp +public double MaxFilePathLength { get; set; } +``` + +- *Type:* double + +The maximum allowed length of a file path. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#max_file_path_length RepositoryRuleset#max_file_path_length} + +--- + +### RepositoryRulesetRulesMaxFileSize + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesMaxFileSize { + double MaxFileSize +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| MaxFileSize | double | The maximum allowed size of a file in megabytes (MB). Valid range is 1-100 MB. | + +--- + +##### `MaxFileSize`Required + +```csharp +public double MaxFileSize { get; set; } +``` + +- *Type:* double + +The maximum allowed size of a file in megabytes (MB). Valid range is 1-100 MB. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#max_file_size RepositoryRuleset#max_file_size} + +--- + +### RepositoryRulesetRulesMergeQueue + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesMergeQueue { + double CheckResponseTimeoutMinutes = null, + string GroupingStrategy = null, + double MaxEntriesToBuild = null, + double MaxEntriesToMerge = null, + string MergeMethod = null, + double MinEntriesToMerge = null, + double MinEntriesToMergeWaitMinutes = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CheckResponseTimeoutMinutes | double | Maximum time for a required status check to report a conclusion. | +| GroupingStrategy | string | When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. | +| MaxEntriesToBuild | double | Limit the number of queued pull requests requesting checks and workflow runs at the same time. Defaults to `5`. | +| MaxEntriesToMerge | double | The maximum number of PRs that will be merged together in a group. Defaults to `5`. | +| MergeMethod | string | Method to use when merging changes from queued pull requests. | +| MinEntriesToMerge | double | The minimum number of PRs that will be merged together in a group. Defaults to `1`. | +| MinEntriesToMergeWaitMinutes | double | The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. | + +--- + +##### `CheckResponseTimeoutMinutes`Optional + +```csharp +public double CheckResponseTimeoutMinutes { get; set; } +``` + +- *Type:* double + +Maximum time for a required status check to report a conclusion. + +After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed. Defaults to `60`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#check_response_timeout_minutes RepositoryRuleset#check_response_timeout_minutes} + +--- + +##### `GroupingStrategy`Optional + +```csharp +public string GroupingStrategy { get; set; } +``` + +- *Type:* string + +When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. + +When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. Can be one of: ALLGREEN, HEADGREEN. Defaults to `ALLGREEN`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#grouping_strategy RepositoryRuleset#grouping_strategy} + +--- + +##### `MaxEntriesToBuild`Optional + +```csharp +public double MaxEntriesToBuild { get; set; } +``` + +- *Type:* double + +Limit the number of queued pull requests requesting checks and workflow runs at the same time. Defaults to `5`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#max_entries_to_build RepositoryRuleset#max_entries_to_build} + +--- + +##### `MaxEntriesToMerge`Optional + +```csharp +public double MaxEntriesToMerge { get; set; } +``` + +- *Type:* double + +The maximum number of PRs that will be merged together in a group. Defaults to `5`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#max_entries_to_merge RepositoryRuleset#max_entries_to_merge} + +--- + +##### `MergeMethod`Optional + +```csharp +public string MergeMethod { get; set; } +``` + +- *Type:* string + +Method to use when merging changes from queued pull requests. + +Can be one of: MERGE, SQUASH, REBASE. Defaults to `MERGE`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#merge_method RepositoryRuleset#merge_method} + +--- + +##### `MinEntriesToMerge`Optional + +```csharp +public double MinEntriesToMerge { get; set; } +``` + +- *Type:* double + +The minimum number of PRs that will be merged together in a group. Defaults to `1`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#min_entries_to_merge RepositoryRuleset#min_entries_to_merge} + +--- + +##### `MinEntriesToMergeWaitMinutes`Optional + +```csharp +public double MinEntriesToMergeWaitMinutes { get; set; } +``` + +- *Type:* double + +The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. + +After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. Defaults to `5`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#min_entries_to_merge_wait_minutes RepositoryRuleset#min_entries_to_merge_wait_minutes} + +--- + +### RepositoryRulesetRulesPullRequest + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesPullRequest { + string[] AllowedMergeMethods = null, + bool|IResolvable DismissStaleReviewsOnPush = null, + bool|IResolvable RequireCodeOwnerReview = null, + double RequiredApprovingReviewCount = null, + IResolvable|RepositoryRulesetRulesPullRequestRequiredReviewers[] RequiredReviewers = null, + bool|IResolvable RequiredReviewThreadResolution = null, + bool|IResolvable RequireLastPushApproval = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| AllowedMergeMethods | string[] | Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled. | +| DismissStaleReviewsOnPush | bool\|Io.Cdktn.IResolvable | New, reviewable commits pushed will dismiss previous pull request review approvals. Defaults to `false`. | +| RequireCodeOwnerReview | bool\|Io.Cdktn.IResolvable | Require an approving review in pull requests that modify files that have a designated code owner. Defaults to `false`. | +| RequiredApprovingReviewCount | double | The number of approving reviews that are required before a pull request can be merged. Defaults to `0`. | +| RequiredReviewers | Io.Cdktn.IResolvable\|RepositoryRulesetRulesPullRequestRequiredReviewers[] | required_reviewers block. | +| RequiredReviewThreadResolution | bool\|Io.Cdktn.IResolvable | All conversations on code must be resolved before a pull request can be merged. Defaults to `false`. | +| RequireLastPushApproval | bool\|Io.Cdktn.IResolvable | Whether the most recent reviewable push must be approved by someone other than the person who pushed it. | + +--- + +##### `AllowedMergeMethods`Optional + +```csharp +public string[] AllowedMergeMethods { get; set; } +``` + +- *Type:* string[] + +Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#allowed_merge_methods RepositoryRuleset#allowed_merge_methods} + +--- + +##### `DismissStaleReviewsOnPush`Optional + +```csharp +public bool|IResolvable DismissStaleReviewsOnPush { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +New, reviewable commits pushed will dismiss previous pull request review approvals. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#dismiss_stale_reviews_on_push RepositoryRuleset#dismiss_stale_reviews_on_push} + +--- + +##### `RequireCodeOwnerReview`Optional + +```csharp +public bool|IResolvable RequireCodeOwnerReview { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Require an approving review in pull requests that modify files that have a designated code owner. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#require_code_owner_review RepositoryRuleset#require_code_owner_review} + +--- + +##### `RequiredApprovingReviewCount`Optional + +```csharp +public double RequiredApprovingReviewCount { get; set; } +``` + +- *Type:* double + +The number of approving reviews that are required before a pull request can be merged. Defaults to `0`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#required_approving_review_count RepositoryRuleset#required_approving_review_count} + +--- + +##### `RequiredReviewers`Optional + +```csharp +public IResolvable|RepositoryRulesetRulesPullRequestRequiredReviewers[] RequiredReviewers { get; set; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryRulesetRulesPullRequestRequiredReviewers[] + +required_reviewers block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#required_reviewers RepositoryRuleset#required_reviewers} + +--- + +##### `RequiredReviewThreadResolution`Optional + +```csharp +public bool|IResolvable RequiredReviewThreadResolution { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +All conversations on code must be resolved before a pull request can be merged. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#required_review_thread_resolution RepositoryRuleset#required_review_thread_resolution} + +--- + +##### `RequireLastPushApproval`Optional + +```csharp +public bool|IResolvable RequireLastPushApproval { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether the most recent reviewable push must be approved by someone other than the person who pushed it. + +Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#require_last_push_approval RepositoryRuleset#require_last_push_approval} + +--- + +### RepositoryRulesetRulesPullRequestRequiredReviewers + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesPullRequestRequiredReviewers { + string[] FilePatterns, + double MinimumApprovals, + RepositoryRulesetRulesPullRequestRequiredReviewersReviewer Reviewer +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| FilePatterns | string[] | File patterns (fnmatch syntax) that this reviewer must approve. | +| MinimumApprovals | double | Minimum number of approvals required from this reviewer. Set to 0 to make approval optional. | +| Reviewer | RepositoryRulesetRulesPullRequestRequiredReviewersReviewer | reviewer block. | + +--- + +##### `FilePatterns`Required + +```csharp +public string[] FilePatterns { get; set; } +``` + +- *Type:* string[] + +File patterns (fnmatch syntax) that this reviewer must approve. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#file_patterns RepositoryRuleset#file_patterns} + +--- + +##### `MinimumApprovals`Required + +```csharp +public double MinimumApprovals { get; set; } +``` + +- *Type:* double + +Minimum number of approvals required from this reviewer. Set to 0 to make approval optional. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#minimum_approvals RepositoryRuleset#minimum_approvals} + +--- + +##### `Reviewer`Required + +```csharp +public RepositoryRulesetRulesPullRequestRequiredReviewersReviewer Reviewer { get; set; } +``` + +- *Type:* RepositoryRulesetRulesPullRequestRequiredReviewersReviewer + +reviewer block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#reviewer RepositoryRuleset#reviewer} + +--- + +### RepositoryRulesetRulesPullRequestRequiredReviewersReviewer + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesPullRequestRequiredReviewersReviewer { + double Id, + string Type +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Id | double | The ID of the reviewer that must review. | +| Type | string | The type of reviewer. Currently only `Team` is supported. | + +--- + +##### `Id`Required + +```csharp +public double Id { get; set; } +``` + +- *Type:* double + +The ID of the reviewer that must review. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#id RepositoryRuleset#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`Required + +```csharp +public string Type { get; set; } +``` + +- *Type:* string + +The type of reviewer. Currently only `Team` is supported. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#type RepositoryRuleset#type} + +--- + +### RepositoryRulesetRulesRequiredCodeScanning + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesRequiredCodeScanning { + IResolvable|RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] RequiredCodeScanningTool +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| RequiredCodeScanningTool | Io.Cdktn.IResolvable\|RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] | required_code_scanning_tool block. | + +--- + +##### `RequiredCodeScanningTool`Required + +```csharp +public IResolvable|RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] RequiredCodeScanningTool { get; set; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] + +required_code_scanning_tool block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#required_code_scanning_tool RepositoryRuleset#required_code_scanning_tool} + +--- + +### RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool { + string AlertsThreshold, + string SecurityAlertsThreshold, + string Tool +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| AlertsThreshold | string | The severity level at which code scanning results that raise alerts block a reference update. | +| SecurityAlertsThreshold | string | The severity level at which code scanning results that raise security alerts block a reference update. | +| Tool | string | The name of a code scanning tool. | + +--- + +##### `AlertsThreshold`Required + +```csharp +public string AlertsThreshold { get; set; } +``` + +- *Type:* string + +The severity level at which code scanning results that raise alerts block a reference update. + +Can be one of: `none`, `errors`, `errors_and_warnings`, `all`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#alerts_threshold RepositoryRuleset#alerts_threshold} + +--- + +##### `SecurityAlertsThreshold`Required + +```csharp +public string SecurityAlertsThreshold { get; set; } +``` + +- *Type:* string + +The severity level at which code scanning results that raise security alerts block a reference update. + +Can be one of: `none`, `critical`, `high_or_higher`, `medium_or_higher`, `all`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#security_alerts_threshold RepositoryRuleset#security_alerts_threshold} + +--- + +##### `Tool`Required + +```csharp +public string Tool { get; set; } +``` + +- *Type:* string + +The name of a code scanning tool. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#tool RepositoryRuleset#tool} + +--- + +### RepositoryRulesetRulesRequiredDeployments + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesRequiredDeployments { + string[] RequiredDeploymentEnvironments +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| RequiredDeploymentEnvironments | string[] | The environments that must be successfully deployed to before branches can be merged. | + +--- + +##### `RequiredDeploymentEnvironments`Required + +```csharp +public string[] RequiredDeploymentEnvironments { get; set; } +``` + +- *Type:* string[] + +The environments that must be successfully deployed to before branches can be merged. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#required_deployment_environments RepositoryRuleset#required_deployment_environments} + +--- + +### RepositoryRulesetRulesRequiredStatusChecks + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesRequiredStatusChecks { + IResolvable|RepositoryRulesetRulesRequiredStatusChecksRequiredCheck[] RequiredCheck, + bool|IResolvable DoNotEnforceOnCreate = null, + bool|IResolvable StrictRequiredStatusChecksPolicy = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| RequiredCheck | Io.Cdktn.IResolvable\|RepositoryRulesetRulesRequiredStatusChecksRequiredCheck[] | required_check block. | +| DoNotEnforceOnCreate | bool\|Io.Cdktn.IResolvable | Allow repositories and branches to be created if a check would otherwise prohibit it. | +| StrictRequiredStatusChecksPolicy | bool\|Io.Cdktn.IResolvable | Whether pull requests targeting a matching branch must be tested with the latest code. | + +--- + +##### `RequiredCheck`Required + +```csharp +public IResolvable|RepositoryRulesetRulesRequiredStatusChecksRequiredCheck[] RequiredCheck { get; set; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryRulesetRulesRequiredStatusChecksRequiredCheck[] + +required_check block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#required_check RepositoryRuleset#required_check} + +--- + +##### `DoNotEnforceOnCreate`Optional + +```csharp +public bool|IResolvable DoNotEnforceOnCreate { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Allow repositories and branches to be created if a check would otherwise prohibit it. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#do_not_enforce_on_create RepositoryRuleset#do_not_enforce_on_create} + +--- + +##### `StrictRequiredStatusChecksPolicy`Optional + +```csharp +public bool|IResolvable StrictRequiredStatusChecksPolicy { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether pull requests targeting a matching branch must be tested with the latest code. + +This setting will not take effect unless at least one status check is enabled. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#strict_required_status_checks_policy RepositoryRuleset#strict_required_status_checks_policy} + +--- + +### RepositoryRulesetRulesRequiredStatusChecksRequiredCheck + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesRequiredStatusChecksRequiredCheck { + string Context, + double IntegrationId = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Context | string | The status check context name that must be present on the commit. | +| IntegrationId | double | The optional integration ID that this status check must originate from. | + +--- + +##### `Context`Required + +```csharp +public string Context { get; set; } +``` + +- *Type:* string + +The status check context name that must be present on the commit. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#context RepositoryRuleset#context} + +--- + +##### `IntegrationId`Optional + +```csharp +public double IntegrationId { get; set; } +``` + +- *Type:* double + +The optional integration ID that this status check must originate from. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#integration_id RepositoryRuleset#integration_id} + +--- + +### RepositoryRulesetRulesTagNamePattern + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesTagNamePattern { + string Operator, + string Pattern, + string Name = null, + bool|IResolvable Negate = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Operator | string | The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. | +| Pattern | string | The pattern to match with. | +| Name | string | How this rule will appear to users. | +| Negate | bool\|Io.Cdktn.IResolvable | If true, the rule will fail if the pattern matches. | + +--- + +##### `Operator`Required + +```csharp +public string Operator { get; set; } +``` + +- *Type:* string + +The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#operator RepositoryRuleset#operator} + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; set; } +``` + +- *Type:* string + +The pattern to match with. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#pattern RepositoryRuleset#pattern} + +--- + +##### `Name`Optional + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +How this rule will appear to users. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#name RepositoryRuleset#name} + +--- + +##### `Negate`Optional + +```csharp +public bool|IResolvable Negate { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +If true, the rule will fail if the pattern matches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#negate RepositoryRuleset#negate} + +--- + +## Classes + +### RepositoryRulesetBypassActorsList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetBypassActorsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private RepositoryRulesetBypassActorsOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|RepositoryRulesetBypassActors[] | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|RepositoryRulesetBypassActors[] InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryRulesetBypassActors[] + +--- + + +### RepositoryRulesetBypassActorsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetBypassActorsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetActorId | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetActorId` + +```csharp +private void ResetActorId() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| ActorIdInput | double | *No description.* | +| ActorTypeInput | string | *No description.* | +| BypassModeInput | string | *No description.* | +| ActorId | double | *No description.* | +| ActorType | string | *No description.* | +| BypassMode | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|RepositoryRulesetBypassActors | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `ActorIdInput`Optional + +```csharp +public double ActorIdInput { get; } +``` + +- *Type:* double + +--- + +##### `ActorTypeInput`Optional + +```csharp +public string ActorTypeInput { get; } +``` + +- *Type:* string + +--- + +##### `BypassModeInput`Optional + +```csharp +public string BypassModeInput { get; } +``` + +- *Type:* string + +--- + +##### `ActorId`Required + +```csharp +public double ActorId { get; } +``` + +- *Type:* double + +--- + +##### `ActorType`Required + +```csharp +public string ActorType { get; } +``` + +- *Type:* string + +--- + +##### `BypassMode`Required + +```csharp +public string BypassMode { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|RepositoryRulesetBypassActors InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryRulesetBypassActors + +--- + + +### RepositoryRulesetConditionsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetConditionsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| PutRefName | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `PutRefName` + +```csharp +private void PutRefName(RepositoryRulesetConditionsRefName Value) +``` + +###### `Value`Required + +- *Type:* RepositoryRulesetConditionsRefName + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| RefName | RepositoryRulesetConditionsRefNameOutputReference | *No description.* | +| RefNameInput | RepositoryRulesetConditionsRefName | *No description.* | +| InternalValue | RepositoryRulesetConditions | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `RefName`Required + +```csharp +public RepositoryRulesetConditionsRefNameOutputReference RefName { get; } +``` + +- *Type:* RepositoryRulesetConditionsRefNameOutputReference + +--- + +##### `RefNameInput`Optional + +```csharp +public RepositoryRulesetConditionsRefName RefNameInput { get; } +``` + +- *Type:* RepositoryRulesetConditionsRefName + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryRulesetConditions InternalValue { get; } +``` + +- *Type:* RepositoryRulesetConditions + +--- + + +### RepositoryRulesetConditionsRefNameOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetConditionsRefNameOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| ExcludeInput | string[] | *No description.* | +| IncludeInput | string[] | *No description.* | +| Exclude | string[] | *No description.* | +| Include | string[] | *No description.* | +| InternalValue | RepositoryRulesetConditionsRefName | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `ExcludeInput`Optional + +```csharp +public string[] ExcludeInput { get; } +``` + +- *Type:* string[] + +--- + +##### `IncludeInput`Optional + +```csharp +public string[] IncludeInput { get; } +``` + +- *Type:* string[] + +--- + +##### `Exclude`Required + +```csharp +public string[] Exclude { get; } +``` + +- *Type:* string[] + +--- + +##### `Include`Required + +```csharp +public string[] Include { get; } +``` + +- *Type:* string[] + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryRulesetConditionsRefName InternalValue { get; } +``` + +- *Type:* RepositoryRulesetConditionsRefName + +--- + + +### RepositoryRulesetRulesBranchNamePatternOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesBranchNamePatternOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetName | *No description.* | +| ResetNegate | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetName` + +```csharp +private void ResetName() +``` + +##### `ResetNegate` + +```csharp +private void ResetNegate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| NameInput | string | *No description.* | +| NegateInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| OperatorInput | string | *No description.* | +| PatternInput | string | *No description.* | +| Name | string | *No description.* | +| Negate | bool\|Io.Cdktn.IResolvable | *No description.* | +| Operator | string | *No description.* | +| Pattern | string | *No description.* | +| InternalValue | RepositoryRulesetRulesBranchNamePattern | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `NegateInput`Optional + +```csharp +public bool|IResolvable NegateInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `OperatorInput`Optional + +```csharp +public string OperatorInput { get; } +``` + +- *Type:* string + +--- + +##### `PatternInput`Optional + +```csharp +public string PatternInput { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Negate`Required + +```csharp +public bool|IResolvable Negate { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Operator`Required + +```csharp +public string Operator { get; } +``` + +- *Type:* string + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryRulesetRulesBranchNamePattern InternalValue { get; } +``` + +- *Type:* RepositoryRulesetRulesBranchNamePattern + +--- + + +### RepositoryRulesetRulesCommitAuthorEmailPatternOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesCommitAuthorEmailPatternOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetName | *No description.* | +| ResetNegate | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetName` + +```csharp +private void ResetName() +``` + +##### `ResetNegate` + +```csharp +private void ResetNegate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| NameInput | string | *No description.* | +| NegateInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| OperatorInput | string | *No description.* | +| PatternInput | string | *No description.* | +| Name | string | *No description.* | +| Negate | bool\|Io.Cdktn.IResolvable | *No description.* | +| Operator | string | *No description.* | +| Pattern | string | *No description.* | +| InternalValue | RepositoryRulesetRulesCommitAuthorEmailPattern | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `NegateInput`Optional + +```csharp +public bool|IResolvable NegateInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `OperatorInput`Optional + +```csharp +public string OperatorInput { get; } +``` + +- *Type:* string + +--- + +##### `PatternInput`Optional + +```csharp +public string PatternInput { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Negate`Required + +```csharp +public bool|IResolvable Negate { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Operator`Required + +```csharp +public string Operator { get; } +``` + +- *Type:* string + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryRulesetRulesCommitAuthorEmailPattern InternalValue { get; } +``` + +- *Type:* RepositoryRulesetRulesCommitAuthorEmailPattern + +--- + + +### RepositoryRulesetRulesCommitMessagePatternOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesCommitMessagePatternOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetName | *No description.* | +| ResetNegate | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetName` + +```csharp +private void ResetName() +``` + +##### `ResetNegate` + +```csharp +private void ResetNegate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| NameInput | string | *No description.* | +| NegateInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| OperatorInput | string | *No description.* | +| PatternInput | string | *No description.* | +| Name | string | *No description.* | +| Negate | bool\|Io.Cdktn.IResolvable | *No description.* | +| Operator | string | *No description.* | +| Pattern | string | *No description.* | +| InternalValue | RepositoryRulesetRulesCommitMessagePattern | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `NegateInput`Optional + +```csharp +public bool|IResolvable NegateInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `OperatorInput`Optional + +```csharp +public string OperatorInput { get; } +``` + +- *Type:* string + +--- + +##### `PatternInput`Optional + +```csharp +public string PatternInput { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Negate`Required + +```csharp +public bool|IResolvable Negate { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Operator`Required + +```csharp +public string Operator { get; } +``` + +- *Type:* string + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryRulesetRulesCommitMessagePattern InternalValue { get; } +``` + +- *Type:* RepositoryRulesetRulesCommitMessagePattern + +--- + + +### RepositoryRulesetRulesCommitterEmailPatternOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesCommitterEmailPatternOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetName | *No description.* | +| ResetNegate | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetName` + +```csharp +private void ResetName() +``` + +##### `ResetNegate` + +```csharp +private void ResetNegate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| NameInput | string | *No description.* | +| NegateInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| OperatorInput | string | *No description.* | +| PatternInput | string | *No description.* | +| Name | string | *No description.* | +| Negate | bool\|Io.Cdktn.IResolvable | *No description.* | +| Operator | string | *No description.* | +| Pattern | string | *No description.* | +| InternalValue | RepositoryRulesetRulesCommitterEmailPattern | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `NegateInput`Optional + +```csharp +public bool|IResolvable NegateInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `OperatorInput`Optional + +```csharp +public string OperatorInput { get; } +``` + +- *Type:* string + +--- + +##### `PatternInput`Optional + +```csharp +public string PatternInput { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Negate`Required + +```csharp +public bool|IResolvable Negate { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Operator`Required + +```csharp +public string Operator { get; } +``` + +- *Type:* string + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryRulesetRulesCommitterEmailPattern InternalValue { get; } +``` + +- *Type:* RepositoryRulesetRulesCommitterEmailPattern + +--- + + +### RepositoryRulesetRulesCopilotCodeReviewOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesCopilotCodeReviewOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetReviewDraftPullRequests | *No description.* | +| ResetReviewOnPush | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetReviewDraftPullRequests` + +```csharp +private void ResetReviewDraftPullRequests() +``` + +##### `ResetReviewOnPush` + +```csharp +private void ResetReviewOnPush() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| ReviewDraftPullRequestsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| ReviewOnPushInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| ReviewDraftPullRequests | bool\|Io.Cdktn.IResolvable | *No description.* | +| ReviewOnPush | bool\|Io.Cdktn.IResolvable | *No description.* | +| InternalValue | RepositoryRulesetRulesCopilotCodeReview | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `ReviewDraftPullRequestsInput`Optional + +```csharp +public bool|IResolvable ReviewDraftPullRequestsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ReviewOnPushInput`Optional + +```csharp +public bool|IResolvable ReviewOnPushInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ReviewDraftPullRequests`Required + +```csharp +public bool|IResolvable ReviewDraftPullRequests { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ReviewOnPush`Required + +```csharp +public bool|IResolvable ReviewOnPush { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryRulesetRulesCopilotCodeReview InternalValue { get; } +``` + +- *Type:* RepositoryRulesetRulesCopilotCodeReview + +--- + + +### RepositoryRulesetRulesFileExtensionRestrictionOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesFileExtensionRestrictionOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| RestrictedFileExtensionsInput | string[] | *No description.* | +| RestrictedFileExtensions | string[] | *No description.* | +| InternalValue | RepositoryRulesetRulesFileExtensionRestriction | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `RestrictedFileExtensionsInput`Optional + +```csharp +public string[] RestrictedFileExtensionsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `RestrictedFileExtensions`Required + +```csharp +public string[] RestrictedFileExtensions { get; } +``` + +- *Type:* string[] + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryRulesetRulesFileExtensionRestriction InternalValue { get; } +``` + +- *Type:* RepositoryRulesetRulesFileExtensionRestriction + +--- + + +### RepositoryRulesetRulesFilePathRestrictionOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesFilePathRestrictionOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| RestrictedFilePathsInput | string[] | *No description.* | +| RestrictedFilePaths | string[] | *No description.* | +| InternalValue | RepositoryRulesetRulesFilePathRestriction | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `RestrictedFilePathsInput`Optional + +```csharp +public string[] RestrictedFilePathsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `RestrictedFilePaths`Required + +```csharp +public string[] RestrictedFilePaths { get; } +``` + +- *Type:* string[] + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryRulesetRulesFilePathRestriction InternalValue { get; } +``` + +- *Type:* RepositoryRulesetRulesFilePathRestriction + +--- + + +### RepositoryRulesetRulesMaxFilePathLengthOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesMaxFilePathLengthOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| MaxFilePathLengthInput | double | *No description.* | +| MaxFilePathLength | double | *No description.* | +| InternalValue | RepositoryRulesetRulesMaxFilePathLength | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `MaxFilePathLengthInput`Optional + +```csharp +public double MaxFilePathLengthInput { get; } +``` + +- *Type:* double + +--- + +##### `MaxFilePathLength`Required + +```csharp +public double MaxFilePathLength { get; } +``` + +- *Type:* double + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryRulesetRulesMaxFilePathLength InternalValue { get; } +``` + +- *Type:* RepositoryRulesetRulesMaxFilePathLength + +--- + + +### RepositoryRulesetRulesMaxFileSizeOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesMaxFileSizeOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| MaxFileSizeInput | double | *No description.* | +| MaxFileSize | double | *No description.* | +| InternalValue | RepositoryRulesetRulesMaxFileSize | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `MaxFileSizeInput`Optional + +```csharp +public double MaxFileSizeInput { get; } +``` + +- *Type:* double + +--- + +##### `MaxFileSize`Required + +```csharp +public double MaxFileSize { get; } +``` + +- *Type:* double + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryRulesetRulesMaxFileSize InternalValue { get; } +``` + +- *Type:* RepositoryRulesetRulesMaxFileSize + +--- + + +### RepositoryRulesetRulesMergeQueueOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesMergeQueueOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetCheckResponseTimeoutMinutes | *No description.* | +| ResetGroupingStrategy | *No description.* | +| ResetMaxEntriesToBuild | *No description.* | +| ResetMaxEntriesToMerge | *No description.* | +| ResetMergeMethod | *No description.* | +| ResetMinEntriesToMerge | *No description.* | +| ResetMinEntriesToMergeWaitMinutes | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetCheckResponseTimeoutMinutes` + +```csharp +private void ResetCheckResponseTimeoutMinutes() +``` + +##### `ResetGroupingStrategy` + +```csharp +private void ResetGroupingStrategy() +``` + +##### `ResetMaxEntriesToBuild` + +```csharp +private void ResetMaxEntriesToBuild() +``` + +##### `ResetMaxEntriesToMerge` + +```csharp +private void ResetMaxEntriesToMerge() +``` + +##### `ResetMergeMethod` + +```csharp +private void ResetMergeMethod() +``` + +##### `ResetMinEntriesToMerge` + +```csharp +private void ResetMinEntriesToMerge() +``` + +##### `ResetMinEntriesToMergeWaitMinutes` + +```csharp +private void ResetMinEntriesToMergeWaitMinutes() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| CheckResponseTimeoutMinutesInput | double | *No description.* | +| GroupingStrategyInput | string | *No description.* | +| MaxEntriesToBuildInput | double | *No description.* | +| MaxEntriesToMergeInput | double | *No description.* | +| MergeMethodInput | string | *No description.* | +| MinEntriesToMergeInput | double | *No description.* | +| MinEntriesToMergeWaitMinutesInput | double | *No description.* | +| CheckResponseTimeoutMinutes | double | *No description.* | +| GroupingStrategy | string | *No description.* | +| MaxEntriesToBuild | double | *No description.* | +| MaxEntriesToMerge | double | *No description.* | +| MergeMethod | string | *No description.* | +| MinEntriesToMerge | double | *No description.* | +| MinEntriesToMergeWaitMinutes | double | *No description.* | +| InternalValue | RepositoryRulesetRulesMergeQueue | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `CheckResponseTimeoutMinutesInput`Optional + +```csharp +public double CheckResponseTimeoutMinutesInput { get; } +``` + +- *Type:* double + +--- + +##### `GroupingStrategyInput`Optional + +```csharp +public string GroupingStrategyInput { get; } +``` + +- *Type:* string + +--- + +##### `MaxEntriesToBuildInput`Optional + +```csharp +public double MaxEntriesToBuildInput { get; } +``` + +- *Type:* double + +--- + +##### `MaxEntriesToMergeInput`Optional + +```csharp +public double MaxEntriesToMergeInput { get; } +``` + +- *Type:* double + +--- + +##### `MergeMethodInput`Optional + +```csharp +public string MergeMethodInput { get; } +``` + +- *Type:* string + +--- + +##### `MinEntriesToMergeInput`Optional + +```csharp +public double MinEntriesToMergeInput { get; } +``` + +- *Type:* double + +--- + +##### `MinEntriesToMergeWaitMinutesInput`Optional + +```csharp +public double MinEntriesToMergeWaitMinutesInput { get; } +``` + +- *Type:* double + +--- + +##### `CheckResponseTimeoutMinutes`Required + +```csharp +public double CheckResponseTimeoutMinutes { get; } +``` + +- *Type:* double + +--- + +##### `GroupingStrategy`Required + +```csharp +public string GroupingStrategy { get; } +``` + +- *Type:* string + +--- + +##### `MaxEntriesToBuild`Required + +```csharp +public double MaxEntriesToBuild { get; } +``` + +- *Type:* double + +--- + +##### `MaxEntriesToMerge`Required + +```csharp +public double MaxEntriesToMerge { get; } +``` + +- *Type:* double + +--- + +##### `MergeMethod`Required + +```csharp +public string MergeMethod { get; } +``` + +- *Type:* string + +--- + +##### `MinEntriesToMerge`Required + +```csharp +public double MinEntriesToMerge { get; } +``` + +- *Type:* double + +--- + +##### `MinEntriesToMergeWaitMinutes`Required + +```csharp +public double MinEntriesToMergeWaitMinutes { get; } +``` + +- *Type:* double + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryRulesetRulesMergeQueue InternalValue { get; } +``` + +- *Type:* RepositoryRulesetRulesMergeQueue + +--- + + +### RepositoryRulesetRulesOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| PutBranchNamePattern | *No description.* | +| PutCommitAuthorEmailPattern | *No description.* | +| PutCommitMessagePattern | *No description.* | +| PutCommitterEmailPattern | *No description.* | +| PutCopilotCodeReview | *No description.* | +| PutFileExtensionRestriction | *No description.* | +| PutFilePathRestriction | *No description.* | +| PutMaxFilePathLength | *No description.* | +| PutMaxFileSize | *No description.* | +| PutMergeQueue | *No description.* | +| PutPullRequest | *No description.* | +| PutRequiredCodeScanning | *No description.* | +| PutRequiredDeployments | *No description.* | +| PutRequiredStatusChecks | *No description.* | +| PutTagNamePattern | *No description.* | +| ResetBranchNamePattern | *No description.* | +| ResetCommitAuthorEmailPattern | *No description.* | +| ResetCommitMessagePattern | *No description.* | +| ResetCommitterEmailPattern | *No description.* | +| ResetCopilotCodeReview | *No description.* | +| ResetCreation | *No description.* | +| ResetDeletion | *No description.* | +| ResetFileExtensionRestriction | *No description.* | +| ResetFilePathRestriction | *No description.* | +| ResetMaxFilePathLength | *No description.* | +| ResetMaxFileSize | *No description.* | +| ResetMergeQueue | *No description.* | +| ResetNonFastForward | *No description.* | +| ResetPullRequest | *No description.* | +| ResetRequiredCodeScanning | *No description.* | +| ResetRequiredDeployments | *No description.* | +| ResetRequiredLinearHistory | *No description.* | +| ResetRequiredSignatures | *No description.* | +| ResetRequiredStatusChecks | *No description.* | +| ResetTagNamePattern | *No description.* | +| ResetUpdate | *No description.* | +| ResetUpdateAllowsFetchAndMerge | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `PutBranchNamePattern` + +```csharp +private void PutBranchNamePattern(RepositoryRulesetRulesBranchNamePattern Value) +``` + +###### `Value`Required + +- *Type:* RepositoryRulesetRulesBranchNamePattern + +--- + +##### `PutCommitAuthorEmailPattern` + +```csharp +private void PutCommitAuthorEmailPattern(RepositoryRulesetRulesCommitAuthorEmailPattern Value) +``` + +###### `Value`Required + +- *Type:* RepositoryRulesetRulesCommitAuthorEmailPattern + +--- + +##### `PutCommitMessagePattern` + +```csharp +private void PutCommitMessagePattern(RepositoryRulesetRulesCommitMessagePattern Value) +``` + +###### `Value`Required + +- *Type:* RepositoryRulesetRulesCommitMessagePattern + +--- + +##### `PutCommitterEmailPattern` + +```csharp +private void PutCommitterEmailPattern(RepositoryRulesetRulesCommitterEmailPattern Value) +``` + +###### `Value`Required + +- *Type:* RepositoryRulesetRulesCommitterEmailPattern + +--- + +##### `PutCopilotCodeReview` + +```csharp +private void PutCopilotCodeReview(RepositoryRulesetRulesCopilotCodeReview Value) +``` + +###### `Value`Required + +- *Type:* RepositoryRulesetRulesCopilotCodeReview + +--- + +##### `PutFileExtensionRestriction` + +```csharp +private void PutFileExtensionRestriction(RepositoryRulesetRulesFileExtensionRestriction Value) +``` + +###### `Value`Required + +- *Type:* RepositoryRulesetRulesFileExtensionRestriction + +--- + +##### `PutFilePathRestriction` + +```csharp +private void PutFilePathRestriction(RepositoryRulesetRulesFilePathRestriction Value) +``` + +###### `Value`Required + +- *Type:* RepositoryRulesetRulesFilePathRestriction + +--- + +##### `PutMaxFilePathLength` + +```csharp +private void PutMaxFilePathLength(RepositoryRulesetRulesMaxFilePathLength Value) +``` + +###### `Value`Required + +- *Type:* RepositoryRulesetRulesMaxFilePathLength + +--- + +##### `PutMaxFileSize` + +```csharp +private void PutMaxFileSize(RepositoryRulesetRulesMaxFileSize Value) +``` + +###### `Value`Required + +- *Type:* RepositoryRulesetRulesMaxFileSize + +--- + +##### `PutMergeQueue` + +```csharp +private void PutMergeQueue(RepositoryRulesetRulesMergeQueue Value) +``` + +###### `Value`Required + +- *Type:* RepositoryRulesetRulesMergeQueue + +--- + +##### `PutPullRequest` + +```csharp +private void PutPullRequest(RepositoryRulesetRulesPullRequest Value) +``` + +###### `Value`Required + +- *Type:* RepositoryRulesetRulesPullRequest + +--- + +##### `PutRequiredCodeScanning` + +```csharp +private void PutRequiredCodeScanning(RepositoryRulesetRulesRequiredCodeScanning Value) +``` + +###### `Value`Required + +- *Type:* RepositoryRulesetRulesRequiredCodeScanning + +--- + +##### `PutRequiredDeployments` + +```csharp +private void PutRequiredDeployments(RepositoryRulesetRulesRequiredDeployments Value) +``` + +###### `Value`Required + +- *Type:* RepositoryRulesetRulesRequiredDeployments + +--- + +##### `PutRequiredStatusChecks` + +```csharp +private void PutRequiredStatusChecks(RepositoryRulesetRulesRequiredStatusChecks Value) +``` + +###### `Value`Required + +- *Type:* RepositoryRulesetRulesRequiredStatusChecks + +--- + +##### `PutTagNamePattern` + +```csharp +private void PutTagNamePattern(RepositoryRulesetRulesTagNamePattern Value) +``` + +###### `Value`Required + +- *Type:* RepositoryRulesetRulesTagNamePattern + +--- + +##### `ResetBranchNamePattern` + +```csharp +private void ResetBranchNamePattern() +``` + +##### `ResetCommitAuthorEmailPattern` + +```csharp +private void ResetCommitAuthorEmailPattern() +``` + +##### `ResetCommitMessagePattern` + +```csharp +private void ResetCommitMessagePattern() +``` + +##### `ResetCommitterEmailPattern` + +```csharp +private void ResetCommitterEmailPattern() +``` + +##### `ResetCopilotCodeReview` + +```csharp +private void ResetCopilotCodeReview() +``` + +##### `ResetCreation` + +```csharp +private void ResetCreation() +``` + +##### `ResetDeletion` + +```csharp +private void ResetDeletion() +``` + +##### `ResetFileExtensionRestriction` + +```csharp +private void ResetFileExtensionRestriction() +``` + +##### `ResetFilePathRestriction` + +```csharp +private void ResetFilePathRestriction() +``` + +##### `ResetMaxFilePathLength` + +```csharp +private void ResetMaxFilePathLength() +``` + +##### `ResetMaxFileSize` + +```csharp +private void ResetMaxFileSize() +``` + +##### `ResetMergeQueue` + +```csharp +private void ResetMergeQueue() +``` + +##### `ResetNonFastForward` + +```csharp +private void ResetNonFastForward() +``` + +##### `ResetPullRequest` + +```csharp +private void ResetPullRequest() +``` + +##### `ResetRequiredCodeScanning` + +```csharp +private void ResetRequiredCodeScanning() +``` + +##### `ResetRequiredDeployments` + +```csharp +private void ResetRequiredDeployments() +``` + +##### `ResetRequiredLinearHistory` + +```csharp +private void ResetRequiredLinearHistory() +``` + +##### `ResetRequiredSignatures` + +```csharp +private void ResetRequiredSignatures() +``` + +##### `ResetRequiredStatusChecks` + +```csharp +private void ResetRequiredStatusChecks() +``` + +##### `ResetTagNamePattern` + +```csharp +private void ResetTagNamePattern() +``` + +##### `ResetUpdate` + +```csharp +private void ResetUpdate() +``` + +##### `ResetUpdateAllowsFetchAndMerge` + +```csharp +private void ResetUpdateAllowsFetchAndMerge() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| BranchNamePattern | RepositoryRulesetRulesBranchNamePatternOutputReference | *No description.* | +| CommitAuthorEmailPattern | RepositoryRulesetRulesCommitAuthorEmailPatternOutputReference | *No description.* | +| CommitMessagePattern | RepositoryRulesetRulesCommitMessagePatternOutputReference | *No description.* | +| CommitterEmailPattern | RepositoryRulesetRulesCommitterEmailPatternOutputReference | *No description.* | +| CopilotCodeReview | RepositoryRulesetRulesCopilotCodeReviewOutputReference | *No description.* | +| FileExtensionRestriction | RepositoryRulesetRulesFileExtensionRestrictionOutputReference | *No description.* | +| FilePathRestriction | RepositoryRulesetRulesFilePathRestrictionOutputReference | *No description.* | +| MaxFilePathLength | RepositoryRulesetRulesMaxFilePathLengthOutputReference | *No description.* | +| MaxFileSize | RepositoryRulesetRulesMaxFileSizeOutputReference | *No description.* | +| MergeQueue | RepositoryRulesetRulesMergeQueueOutputReference | *No description.* | +| PullRequest | RepositoryRulesetRulesPullRequestOutputReference | *No description.* | +| RequiredCodeScanning | RepositoryRulesetRulesRequiredCodeScanningOutputReference | *No description.* | +| RequiredDeployments | RepositoryRulesetRulesRequiredDeploymentsOutputReference | *No description.* | +| RequiredStatusChecks | RepositoryRulesetRulesRequiredStatusChecksOutputReference | *No description.* | +| TagNamePattern | RepositoryRulesetRulesTagNamePatternOutputReference | *No description.* | +| BranchNamePatternInput | RepositoryRulesetRulesBranchNamePattern | *No description.* | +| CommitAuthorEmailPatternInput | RepositoryRulesetRulesCommitAuthorEmailPattern | *No description.* | +| CommitMessagePatternInput | RepositoryRulesetRulesCommitMessagePattern | *No description.* | +| CommitterEmailPatternInput | RepositoryRulesetRulesCommitterEmailPattern | *No description.* | +| CopilotCodeReviewInput | RepositoryRulesetRulesCopilotCodeReview | *No description.* | +| CreationInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| DeletionInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| FileExtensionRestrictionInput | RepositoryRulesetRulesFileExtensionRestriction | *No description.* | +| FilePathRestrictionInput | RepositoryRulesetRulesFilePathRestriction | *No description.* | +| MaxFilePathLengthInput | RepositoryRulesetRulesMaxFilePathLength | *No description.* | +| MaxFileSizeInput | RepositoryRulesetRulesMaxFileSize | *No description.* | +| MergeQueueInput | RepositoryRulesetRulesMergeQueue | *No description.* | +| NonFastForwardInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| PullRequestInput | RepositoryRulesetRulesPullRequest | *No description.* | +| RequiredCodeScanningInput | RepositoryRulesetRulesRequiredCodeScanning | *No description.* | +| RequiredDeploymentsInput | RepositoryRulesetRulesRequiredDeployments | *No description.* | +| RequiredLinearHistoryInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequiredSignaturesInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequiredStatusChecksInput | RepositoryRulesetRulesRequiredStatusChecks | *No description.* | +| TagNamePatternInput | RepositoryRulesetRulesTagNamePattern | *No description.* | +| UpdateAllowsFetchAndMergeInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| UpdateInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| Creation | bool\|Io.Cdktn.IResolvable | *No description.* | +| Deletion | bool\|Io.Cdktn.IResolvable | *No description.* | +| NonFastForward | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequiredLinearHistory | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequiredSignatures | bool\|Io.Cdktn.IResolvable | *No description.* | +| Update | bool\|Io.Cdktn.IResolvable | *No description.* | +| UpdateAllowsFetchAndMerge | bool\|Io.Cdktn.IResolvable | *No description.* | +| InternalValue | RepositoryRulesetRules | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `BranchNamePattern`Required + +```csharp +public RepositoryRulesetRulesBranchNamePatternOutputReference BranchNamePattern { get; } +``` + +- *Type:* RepositoryRulesetRulesBranchNamePatternOutputReference + +--- + +##### `CommitAuthorEmailPattern`Required + +```csharp +public RepositoryRulesetRulesCommitAuthorEmailPatternOutputReference CommitAuthorEmailPattern { get; } +``` + +- *Type:* RepositoryRulesetRulesCommitAuthorEmailPatternOutputReference + +--- + +##### `CommitMessagePattern`Required + +```csharp +public RepositoryRulesetRulesCommitMessagePatternOutputReference CommitMessagePattern { get; } +``` + +- *Type:* RepositoryRulesetRulesCommitMessagePatternOutputReference + +--- + +##### `CommitterEmailPattern`Required + +```csharp +public RepositoryRulesetRulesCommitterEmailPatternOutputReference CommitterEmailPattern { get; } +``` + +- *Type:* RepositoryRulesetRulesCommitterEmailPatternOutputReference + +--- + +##### `CopilotCodeReview`Required + +```csharp +public RepositoryRulesetRulesCopilotCodeReviewOutputReference CopilotCodeReview { get; } +``` + +- *Type:* RepositoryRulesetRulesCopilotCodeReviewOutputReference + +--- + +##### `FileExtensionRestriction`Required + +```csharp +public RepositoryRulesetRulesFileExtensionRestrictionOutputReference FileExtensionRestriction { get; } +``` + +- *Type:* RepositoryRulesetRulesFileExtensionRestrictionOutputReference + +--- + +##### `FilePathRestriction`Required + +```csharp +public RepositoryRulesetRulesFilePathRestrictionOutputReference FilePathRestriction { get; } +``` + +- *Type:* RepositoryRulesetRulesFilePathRestrictionOutputReference + +--- + +##### `MaxFilePathLength`Required + +```csharp +public RepositoryRulesetRulesMaxFilePathLengthOutputReference MaxFilePathLength { get; } +``` + +- *Type:* RepositoryRulesetRulesMaxFilePathLengthOutputReference + +--- + +##### `MaxFileSize`Required + +```csharp +public RepositoryRulesetRulesMaxFileSizeOutputReference MaxFileSize { get; } +``` + +- *Type:* RepositoryRulesetRulesMaxFileSizeOutputReference + +--- + +##### `MergeQueue`Required + +```csharp +public RepositoryRulesetRulesMergeQueueOutputReference MergeQueue { get; } +``` + +- *Type:* RepositoryRulesetRulesMergeQueueOutputReference + +--- + +##### `PullRequest`Required + +```csharp +public RepositoryRulesetRulesPullRequestOutputReference PullRequest { get; } +``` + +- *Type:* RepositoryRulesetRulesPullRequestOutputReference + +--- + +##### `RequiredCodeScanning`Required + +```csharp +public RepositoryRulesetRulesRequiredCodeScanningOutputReference RequiredCodeScanning { get; } +``` + +- *Type:* RepositoryRulesetRulesRequiredCodeScanningOutputReference + +--- + +##### `RequiredDeployments`Required + +```csharp +public RepositoryRulesetRulesRequiredDeploymentsOutputReference RequiredDeployments { get; } +``` + +- *Type:* RepositoryRulesetRulesRequiredDeploymentsOutputReference + +--- + +##### `RequiredStatusChecks`Required + +```csharp +public RepositoryRulesetRulesRequiredStatusChecksOutputReference RequiredStatusChecks { get; } +``` + +- *Type:* RepositoryRulesetRulesRequiredStatusChecksOutputReference + +--- + +##### `TagNamePattern`Required + +```csharp +public RepositoryRulesetRulesTagNamePatternOutputReference TagNamePattern { get; } +``` + +- *Type:* RepositoryRulesetRulesTagNamePatternOutputReference + +--- + +##### `BranchNamePatternInput`Optional + +```csharp +public RepositoryRulesetRulesBranchNamePattern BranchNamePatternInput { get; } +``` + +- *Type:* RepositoryRulesetRulesBranchNamePattern + +--- + +##### `CommitAuthorEmailPatternInput`Optional + +```csharp +public RepositoryRulesetRulesCommitAuthorEmailPattern CommitAuthorEmailPatternInput { get; } +``` + +- *Type:* RepositoryRulesetRulesCommitAuthorEmailPattern + +--- + +##### `CommitMessagePatternInput`Optional + +```csharp +public RepositoryRulesetRulesCommitMessagePattern CommitMessagePatternInput { get; } +``` + +- *Type:* RepositoryRulesetRulesCommitMessagePattern + +--- + +##### `CommitterEmailPatternInput`Optional + +```csharp +public RepositoryRulesetRulesCommitterEmailPattern CommitterEmailPatternInput { get; } +``` + +- *Type:* RepositoryRulesetRulesCommitterEmailPattern + +--- + +##### `CopilotCodeReviewInput`Optional + +```csharp +public RepositoryRulesetRulesCopilotCodeReview CopilotCodeReviewInput { get; } +``` + +- *Type:* RepositoryRulesetRulesCopilotCodeReview + +--- + +##### `CreationInput`Optional + +```csharp +public bool|IResolvable CreationInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `DeletionInput`Optional + +```csharp +public bool|IResolvable DeletionInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `FileExtensionRestrictionInput`Optional + +```csharp +public RepositoryRulesetRulesFileExtensionRestriction FileExtensionRestrictionInput { get; } +``` + +- *Type:* RepositoryRulesetRulesFileExtensionRestriction + +--- + +##### `FilePathRestrictionInput`Optional + +```csharp +public RepositoryRulesetRulesFilePathRestriction FilePathRestrictionInput { get; } +``` + +- *Type:* RepositoryRulesetRulesFilePathRestriction + +--- + +##### `MaxFilePathLengthInput`Optional + +```csharp +public RepositoryRulesetRulesMaxFilePathLength MaxFilePathLengthInput { get; } +``` + +- *Type:* RepositoryRulesetRulesMaxFilePathLength + +--- + +##### `MaxFileSizeInput`Optional + +```csharp +public RepositoryRulesetRulesMaxFileSize MaxFileSizeInput { get; } +``` + +- *Type:* RepositoryRulesetRulesMaxFileSize + +--- + +##### `MergeQueueInput`Optional + +```csharp +public RepositoryRulesetRulesMergeQueue MergeQueueInput { get; } +``` + +- *Type:* RepositoryRulesetRulesMergeQueue + +--- + +##### `NonFastForwardInput`Optional + +```csharp +public bool|IResolvable NonFastForwardInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `PullRequestInput`Optional + +```csharp +public RepositoryRulesetRulesPullRequest PullRequestInput { get; } +``` + +- *Type:* RepositoryRulesetRulesPullRequest + +--- + +##### `RequiredCodeScanningInput`Optional + +```csharp +public RepositoryRulesetRulesRequiredCodeScanning RequiredCodeScanningInput { get; } +``` + +- *Type:* RepositoryRulesetRulesRequiredCodeScanning + +--- + +##### `RequiredDeploymentsInput`Optional + +```csharp +public RepositoryRulesetRulesRequiredDeployments RequiredDeploymentsInput { get; } +``` + +- *Type:* RepositoryRulesetRulesRequiredDeployments + +--- + +##### `RequiredLinearHistoryInput`Optional + +```csharp +public bool|IResolvable RequiredLinearHistoryInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequiredSignaturesInput`Optional + +```csharp +public bool|IResolvable RequiredSignaturesInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequiredStatusChecksInput`Optional + +```csharp +public RepositoryRulesetRulesRequiredStatusChecks RequiredStatusChecksInput { get; } +``` + +- *Type:* RepositoryRulesetRulesRequiredStatusChecks + +--- + +##### `TagNamePatternInput`Optional + +```csharp +public RepositoryRulesetRulesTagNamePattern TagNamePatternInput { get; } +``` + +- *Type:* RepositoryRulesetRulesTagNamePattern + +--- + +##### `UpdateAllowsFetchAndMergeInput`Optional + +```csharp +public bool|IResolvable UpdateAllowsFetchAndMergeInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `UpdateInput`Optional + +```csharp +public bool|IResolvable UpdateInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Creation`Required + +```csharp +public bool|IResolvable Creation { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Deletion`Required + +```csharp +public bool|IResolvable Deletion { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `NonFastForward`Required + +```csharp +public bool|IResolvable NonFastForward { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequiredLinearHistory`Required + +```csharp +public bool|IResolvable RequiredLinearHistory { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequiredSignatures`Required + +```csharp +public bool|IResolvable RequiredSignatures { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Update`Required + +```csharp +public bool|IResolvable Update { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `UpdateAllowsFetchAndMerge`Required + +```csharp +public bool|IResolvable UpdateAllowsFetchAndMerge { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryRulesetRules InternalValue { get; } +``` + +- *Type:* RepositoryRulesetRules + +--- + + +### RepositoryRulesetRulesPullRequestOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesPullRequestOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| PutRequiredReviewers | *No description.* | +| ResetAllowedMergeMethods | *No description.* | +| ResetDismissStaleReviewsOnPush | *No description.* | +| ResetRequireCodeOwnerReview | *No description.* | +| ResetRequiredApprovingReviewCount | *No description.* | +| ResetRequiredReviewers | *No description.* | +| ResetRequiredReviewThreadResolution | *No description.* | +| ResetRequireLastPushApproval | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `PutRequiredReviewers` + +```csharp +private void PutRequiredReviewers(IResolvable|RepositoryRulesetRulesPullRequestRequiredReviewers[] Value) +``` + +###### `Value`Required + +- *Type:* Io.Cdktn.IResolvable|RepositoryRulesetRulesPullRequestRequiredReviewers[] + +--- + +##### `ResetAllowedMergeMethods` + +```csharp +private void ResetAllowedMergeMethods() +``` + +##### `ResetDismissStaleReviewsOnPush` + +```csharp +private void ResetDismissStaleReviewsOnPush() +``` + +##### `ResetRequireCodeOwnerReview` + +```csharp +private void ResetRequireCodeOwnerReview() +``` + +##### `ResetRequiredApprovingReviewCount` + +```csharp +private void ResetRequiredApprovingReviewCount() +``` + +##### `ResetRequiredReviewers` + +```csharp +private void ResetRequiredReviewers() +``` + +##### `ResetRequiredReviewThreadResolution` + +```csharp +private void ResetRequiredReviewThreadResolution() +``` + +##### `ResetRequireLastPushApproval` + +```csharp +private void ResetRequireLastPushApproval() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| RequiredReviewers | RepositoryRulesetRulesPullRequestRequiredReviewersList | *No description.* | +| AllowedMergeMethodsInput | string[] | *No description.* | +| DismissStaleReviewsOnPushInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequireCodeOwnerReviewInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequiredApprovingReviewCountInput | double | *No description.* | +| RequiredReviewersInput | Io.Cdktn.IResolvable\|RepositoryRulesetRulesPullRequestRequiredReviewers[] | *No description.* | +| RequiredReviewThreadResolutionInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequireLastPushApprovalInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| AllowedMergeMethods | string[] | *No description.* | +| DismissStaleReviewsOnPush | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequireCodeOwnerReview | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequiredApprovingReviewCount | double | *No description.* | +| RequiredReviewThreadResolution | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequireLastPushApproval | bool\|Io.Cdktn.IResolvable | *No description.* | +| InternalValue | RepositoryRulesetRulesPullRequest | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `RequiredReviewers`Required + +```csharp +public RepositoryRulesetRulesPullRequestRequiredReviewersList RequiredReviewers { get; } +``` + +- *Type:* RepositoryRulesetRulesPullRequestRequiredReviewersList + +--- + +##### `AllowedMergeMethodsInput`Optional + +```csharp +public string[] AllowedMergeMethodsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `DismissStaleReviewsOnPushInput`Optional + +```csharp +public bool|IResolvable DismissStaleReviewsOnPushInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequireCodeOwnerReviewInput`Optional + +```csharp +public bool|IResolvable RequireCodeOwnerReviewInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequiredApprovingReviewCountInput`Optional + +```csharp +public double RequiredApprovingReviewCountInput { get; } +``` + +- *Type:* double + +--- + +##### `RequiredReviewersInput`Optional + +```csharp +public IResolvable|RepositoryRulesetRulesPullRequestRequiredReviewers[] RequiredReviewersInput { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryRulesetRulesPullRequestRequiredReviewers[] + +--- + +##### `RequiredReviewThreadResolutionInput`Optional + +```csharp +public bool|IResolvable RequiredReviewThreadResolutionInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequireLastPushApprovalInput`Optional + +```csharp +public bool|IResolvable RequireLastPushApprovalInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `AllowedMergeMethods`Required + +```csharp +public string[] AllowedMergeMethods { get; } +``` + +- *Type:* string[] + +--- + +##### `DismissStaleReviewsOnPush`Required + +```csharp +public bool|IResolvable DismissStaleReviewsOnPush { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequireCodeOwnerReview`Required + +```csharp +public bool|IResolvable RequireCodeOwnerReview { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequiredApprovingReviewCount`Required + +```csharp +public double RequiredApprovingReviewCount { get; } +``` + +- *Type:* double + +--- + +##### `RequiredReviewThreadResolution`Required + +```csharp +public bool|IResolvable RequiredReviewThreadResolution { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequireLastPushApproval`Required + +```csharp +public bool|IResolvable RequireLastPushApproval { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryRulesetRulesPullRequest InternalValue { get; } +``` + +- *Type:* RepositoryRulesetRulesPullRequest + +--- + + +### RepositoryRulesetRulesPullRequestRequiredReviewersList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesPullRequestRequiredReviewersList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private RepositoryRulesetRulesPullRequestRequiredReviewersOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|RepositoryRulesetRulesPullRequestRequiredReviewers[] | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|RepositoryRulesetRulesPullRequestRequiredReviewers[] InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryRulesetRulesPullRequestRequiredReviewers[] + +--- + + +### RepositoryRulesetRulesPullRequestRequiredReviewersOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesPullRequestRequiredReviewersOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| PutReviewer | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `PutReviewer` + +```csharp +private void PutReviewer(RepositoryRulesetRulesPullRequestRequiredReviewersReviewer Value) +``` + +###### `Value`Required + +- *Type:* RepositoryRulesetRulesPullRequestRequiredReviewersReviewer + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| Reviewer | RepositoryRulesetRulesPullRequestRequiredReviewersReviewerOutputReference | *No description.* | +| FilePatternsInput | string[] | *No description.* | +| MinimumApprovalsInput | double | *No description.* | +| ReviewerInput | RepositoryRulesetRulesPullRequestRequiredReviewersReviewer | *No description.* | +| FilePatterns | string[] | *No description.* | +| MinimumApprovals | double | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|RepositoryRulesetRulesPullRequestRequiredReviewers | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `Reviewer`Required + +```csharp +public RepositoryRulesetRulesPullRequestRequiredReviewersReviewerOutputReference Reviewer { get; } +``` + +- *Type:* RepositoryRulesetRulesPullRequestRequiredReviewersReviewerOutputReference + +--- + +##### `FilePatternsInput`Optional + +```csharp +public string[] FilePatternsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `MinimumApprovalsInput`Optional + +```csharp +public double MinimumApprovalsInput { get; } +``` + +- *Type:* double + +--- + +##### `ReviewerInput`Optional + +```csharp +public RepositoryRulesetRulesPullRequestRequiredReviewersReviewer ReviewerInput { get; } +``` + +- *Type:* RepositoryRulesetRulesPullRequestRequiredReviewersReviewer + +--- + +##### `FilePatterns`Required + +```csharp +public string[] FilePatterns { get; } +``` + +- *Type:* string[] + +--- + +##### `MinimumApprovals`Required + +```csharp +public double MinimumApprovals { get; } +``` + +- *Type:* double + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|RepositoryRulesetRulesPullRequestRequiredReviewers InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryRulesetRulesPullRequestRequiredReviewers + +--- + + +### RepositoryRulesetRulesPullRequestRequiredReviewersReviewerOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesPullRequestRequiredReviewersReviewerOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| IdInput | double | *No description.* | +| TypeInput | string | *No description.* | +| Id | double | *No description.* | +| Type | string | *No description.* | +| InternalValue | RepositoryRulesetRulesPullRequestRequiredReviewersReviewer | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public double IdInput { get; } +``` + +- *Type:* double + +--- + +##### `TypeInput`Optional + +```csharp +public string TypeInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public double Id { get; } +``` + +- *Type:* double + +--- + +##### `Type`Required + +```csharp +public string Type { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryRulesetRulesPullRequestRequiredReviewersReviewer InternalValue { get; } +``` + +- *Type:* RepositoryRulesetRulesPullRequestRequiredReviewersReviewer + +--- + + +### RepositoryRulesetRulesRequiredCodeScanningOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesRequiredCodeScanningOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| PutRequiredCodeScanningTool | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `PutRequiredCodeScanningTool` + +```csharp +private void PutRequiredCodeScanningTool(IResolvable|RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] Value) +``` + +###### `Value`Required + +- *Type:* Io.Cdktn.IResolvable|RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| RequiredCodeScanningTool | RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningToolList | *No description.* | +| RequiredCodeScanningToolInput | Io.Cdktn.IResolvable\|RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] | *No description.* | +| InternalValue | RepositoryRulesetRulesRequiredCodeScanning | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `RequiredCodeScanningTool`Required + +```csharp +public RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningToolList RequiredCodeScanningTool { get; } +``` + +- *Type:* RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningToolList + +--- + +##### `RequiredCodeScanningToolInput`Optional + +```csharp +public IResolvable|RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] RequiredCodeScanningToolInput { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryRulesetRulesRequiredCodeScanning InternalValue { get; } +``` + +- *Type:* RepositoryRulesetRulesRequiredCodeScanning + +--- + + +### RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningToolList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningToolList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningToolOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[] + +--- + + +### RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningToolOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningToolOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| AlertsThresholdInput | string | *No description.* | +| SecurityAlertsThresholdInput | string | *No description.* | +| ToolInput | string | *No description.* | +| AlertsThreshold | string | *No description.* | +| SecurityAlertsThreshold | string | *No description.* | +| Tool | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `AlertsThresholdInput`Optional + +```csharp +public string AlertsThresholdInput { get; } +``` + +- *Type:* string + +--- + +##### `SecurityAlertsThresholdInput`Optional + +```csharp +public string SecurityAlertsThresholdInput { get; } +``` + +- *Type:* string + +--- + +##### `ToolInput`Optional + +```csharp +public string ToolInput { get; } +``` + +- *Type:* string + +--- + +##### `AlertsThreshold`Required + +```csharp +public string AlertsThreshold { get; } +``` + +- *Type:* string + +--- + +##### `SecurityAlertsThreshold`Required + +```csharp +public string SecurityAlertsThreshold { get; } +``` + +- *Type:* string + +--- + +##### `Tool`Required + +```csharp +public string Tool { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool + +--- + + +### RepositoryRulesetRulesRequiredDeploymentsOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesRequiredDeploymentsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| RequiredDeploymentEnvironmentsInput | string[] | *No description.* | +| RequiredDeploymentEnvironments | string[] | *No description.* | +| InternalValue | RepositoryRulesetRulesRequiredDeployments | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `RequiredDeploymentEnvironmentsInput`Optional + +```csharp +public string[] RequiredDeploymentEnvironmentsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `RequiredDeploymentEnvironments`Required + +```csharp +public string[] RequiredDeploymentEnvironments { get; } +``` + +- *Type:* string[] + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryRulesetRulesRequiredDeployments InternalValue { get; } +``` + +- *Type:* RepositoryRulesetRulesRequiredDeployments + +--- + + +### RepositoryRulesetRulesRequiredStatusChecksOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesRequiredStatusChecksOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| PutRequiredCheck | *No description.* | +| ResetDoNotEnforceOnCreate | *No description.* | +| ResetStrictRequiredStatusChecksPolicy | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `PutRequiredCheck` + +```csharp +private void PutRequiredCheck(IResolvable|RepositoryRulesetRulesRequiredStatusChecksRequiredCheck[] Value) +``` + +###### `Value`Required + +- *Type:* Io.Cdktn.IResolvable|RepositoryRulesetRulesRequiredStatusChecksRequiredCheck[] + +--- + +##### `ResetDoNotEnforceOnCreate` + +```csharp +private void ResetDoNotEnforceOnCreate() +``` + +##### `ResetStrictRequiredStatusChecksPolicy` + +```csharp +private void ResetStrictRequiredStatusChecksPolicy() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| RequiredCheck | RepositoryRulesetRulesRequiredStatusChecksRequiredCheckList | *No description.* | +| DoNotEnforceOnCreateInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| RequiredCheckInput | Io.Cdktn.IResolvable\|RepositoryRulesetRulesRequiredStatusChecksRequiredCheck[] | *No description.* | +| StrictRequiredStatusChecksPolicyInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| DoNotEnforceOnCreate | bool\|Io.Cdktn.IResolvable | *No description.* | +| StrictRequiredStatusChecksPolicy | bool\|Io.Cdktn.IResolvable | *No description.* | +| InternalValue | RepositoryRulesetRulesRequiredStatusChecks | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `RequiredCheck`Required + +```csharp +public RepositoryRulesetRulesRequiredStatusChecksRequiredCheckList RequiredCheck { get; } +``` + +- *Type:* RepositoryRulesetRulesRequiredStatusChecksRequiredCheckList + +--- + +##### `DoNotEnforceOnCreateInput`Optional + +```csharp +public bool|IResolvable DoNotEnforceOnCreateInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `RequiredCheckInput`Optional + +```csharp +public IResolvable|RepositoryRulesetRulesRequiredStatusChecksRequiredCheck[] RequiredCheckInput { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryRulesetRulesRequiredStatusChecksRequiredCheck[] + +--- + +##### `StrictRequiredStatusChecksPolicyInput`Optional + +```csharp +public bool|IResolvable StrictRequiredStatusChecksPolicyInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `DoNotEnforceOnCreate`Required + +```csharp +public bool|IResolvable DoNotEnforceOnCreate { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `StrictRequiredStatusChecksPolicy`Required + +```csharp +public bool|IResolvable StrictRequiredStatusChecksPolicy { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryRulesetRulesRequiredStatusChecks InternalValue { get; } +``` + +- *Type:* RepositoryRulesetRulesRequiredStatusChecks + +--- + + +### RepositoryRulesetRulesRequiredStatusChecksRequiredCheckList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesRequiredStatusChecksRequiredCheckList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private RepositoryRulesetRulesRequiredStatusChecksRequiredCheckOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|RepositoryRulesetRulesRequiredStatusChecksRequiredCheck[] | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|RepositoryRulesetRulesRequiredStatusChecksRequiredCheck[] InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryRulesetRulesRequiredStatusChecksRequiredCheck[] + +--- + + +### RepositoryRulesetRulesRequiredStatusChecksRequiredCheckOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesRequiredStatusChecksRequiredCheckOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetIntegrationId | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetIntegrationId` + +```csharp +private void ResetIntegrationId() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| ContextInput | string | *No description.* | +| IntegrationIdInput | double | *No description.* | +| Context | string | *No description.* | +| IntegrationId | double | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|RepositoryRulesetRulesRequiredStatusChecksRequiredCheck | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `ContextInput`Optional + +```csharp +public string ContextInput { get; } +``` + +- *Type:* string + +--- + +##### `IntegrationIdInput`Optional + +```csharp +public double IntegrationIdInput { get; } +``` + +- *Type:* double + +--- + +##### `Context`Required + +```csharp +public string Context { get; } +``` + +- *Type:* string + +--- + +##### `IntegrationId`Required + +```csharp +public double IntegrationId { get; } +``` + +- *Type:* double + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|RepositoryRulesetRulesRequiredStatusChecksRequiredCheck InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|RepositoryRulesetRulesRequiredStatusChecksRequiredCheck + +--- + + +### RepositoryRulesetRulesTagNamePatternOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryRulesetRulesTagNamePatternOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetName | *No description.* | +| ResetNegate | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetName` + +```csharp +private void ResetName() +``` + +##### `ResetNegate` + +```csharp +private void ResetNegate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| NameInput | string | *No description.* | +| NegateInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| OperatorInput | string | *No description.* | +| PatternInput | string | *No description.* | +| Name | string | *No description.* | +| Negate | bool\|Io.Cdktn.IResolvable | *No description.* | +| Operator | string | *No description.* | +| Pattern | string | *No description.* | +| InternalValue | RepositoryRulesetRulesTagNamePattern | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `NegateInput`Optional + +```csharp +public bool|IResolvable NegateInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `OperatorInput`Optional + +```csharp +public string OperatorInput { get; } +``` + +- *Type:* string + +--- + +##### `PatternInput`Optional + +```csharp +public string PatternInput { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `Negate`Required + +```csharp +public bool|IResolvable Negate { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Operator`Required + +```csharp +public string Operator { get; } +``` + +- *Type:* string + +--- + +##### `Pattern`Required + +```csharp +public string Pattern { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryRulesetRulesTagNamePattern InternalValue { get; } +``` + +- *Type:* RepositoryRulesetRulesTagNamePattern + +--- + + + diff --git a/docs/repositoryRuleset.java.md b/docs/repositoryRuleset.java.md new file mode 100644 index 000000000..013824503 --- /dev/null +++ b/docs/repositoryRuleset.java.md @@ -0,0 +1,11996 @@ +# `repositoryRuleset` Submodule + +## Constructs + +### RepositoryRuleset + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset github_repository_ruleset}. + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRuleset; + +RepositoryRuleset.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .enforcement(java.lang.String) + .name(java.lang.String) + .repository(java.lang.String) + .rules(RepositoryRulesetRules) + .target(java.lang.String) +// .bypassActors(IResolvable|java.util.List) +// .conditions(RepositoryRulesetConditions) +// .id(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 | *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 | *No description.* | +| enforcement | java.lang.String | Possible values for Enforcement are `disabled`, `active`, `evaluate`. Note: `evaluate` is currently only supported for owners of type `organization`. | +| name | java.lang.String | The name of the ruleset. | +| repository | java.lang.String | Name of the repository to apply ruleset to. | +| rules | RepositoryRulesetRules | rules block. | +| target | java.lang.String | Possible values are branch, push and tag. | +| bypassActors | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryRulesetBypassActors> | bypass_actors block. | +| conditions | RepositoryRulesetConditions | conditions block. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#id RepositoryRuleset#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `enforcement`Required + +- *Type:* java.lang.String + +Possible values for Enforcement are `disabled`, `active`, `evaluate`. Note: `evaluate` is currently only supported for owners of type `organization`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#enforcement RepositoryRuleset#enforcement} + +--- + +##### `name`Required + +- *Type:* java.lang.String + +The name of the ruleset. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#name RepositoryRuleset#name} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +Name of the repository to apply ruleset to. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#repository RepositoryRuleset#repository} + +--- + +##### `rules`Required + +- *Type:* RepositoryRulesetRules + +rules block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#rules RepositoryRuleset#rules} + +--- + +##### `target`Required + +- *Type:* java.lang.String + +Possible values are branch, push and tag. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#target RepositoryRuleset#target} + +--- + +##### `bypassActors`Optional + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryRulesetBypassActors> + +bypass_actors block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#bypass_actors RepositoryRuleset#bypass_actors} + +--- + +##### `conditions`Optional + +- *Type:* RepositoryRulesetConditions + +conditions block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#conditions RepositoryRuleset#conditions} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#id RepositoryRuleset#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| putBypassActors | *No description.* | +| putConditions | *No description.* | +| putRules | *No description.* | +| resetBypassActors | *No description.* | +| resetConditions | *No description.* | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `putBypassActors` + +```java +public void putBypassActors(IResolvable|java.util.List value) +``` + +###### `value`Required + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryRulesetBypassActors> + +--- + +##### `putConditions` + +```java +public void putConditions(RepositoryRulesetConditions value) +``` + +###### `value`Required + +- *Type:* RepositoryRulesetConditions + +--- + +##### `putRules` + +```java +public void putRules(RepositoryRulesetRules value) +``` + +###### `value`Required + +- *Type:* RepositoryRulesetRules + +--- + +##### `resetBypassActors` + +```java +public void resetBypassActors() +``` + +##### `resetConditions` + +```java +public void resetConditions() +``` + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a RepositoryRuleset resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRuleset; + +RepositoryRuleset.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` + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRuleset; + +RepositoryRuleset.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRuleset; + +RepositoryRuleset.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRuleset; + +RepositoryRuleset.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),RepositoryRuleset.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a RepositoryRuleset 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 RepositoryRuleset to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing RepositoryRuleset that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#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 RepositoryRuleset 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| bypassActors | RepositoryRulesetBypassActorsList | *No description.* | +| conditions | RepositoryRulesetConditionsOutputReference | *No description.* | +| etag | java.lang.String | *No description.* | +| nodeId | java.lang.String | *No description.* | +| rules | RepositoryRulesetRulesOutputReference | *No description.* | +| rulesetId | java.lang.Number | *No description.* | +| bypassActorsInput | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryRulesetBypassActors> | *No description.* | +| conditionsInput | RepositoryRulesetConditions | *No description.* | +| enforcementInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| rulesInput | RepositoryRulesetRules | *No description.* | +| targetInput | java.lang.String | *No description.* | +| enforcement | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | +| target | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `bypassActors`Required + +```java +public RepositoryRulesetBypassActorsList getBypassActors(); +``` + +- *Type:* RepositoryRulesetBypassActorsList + +--- + +##### `conditions`Required + +```java +public RepositoryRulesetConditionsOutputReference getConditions(); +``` + +- *Type:* RepositoryRulesetConditionsOutputReference + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `nodeId`Required + +```java +public java.lang.String getNodeId(); +``` + +- *Type:* java.lang.String + +--- + +##### `rules`Required + +```java +public RepositoryRulesetRulesOutputReference getRules(); +``` + +- *Type:* RepositoryRulesetRulesOutputReference + +--- + +##### `rulesetId`Required + +```java +public java.lang.Number getRulesetId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `bypassActorsInput`Optional + +```java +public IResolvable|java.util.List getBypassActorsInput(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryRulesetBypassActors> + +--- + +##### `conditionsInput`Optional + +```java +public RepositoryRulesetConditions getConditionsInput(); +``` + +- *Type:* RepositoryRulesetConditions + +--- + +##### `enforcementInput`Optional + +```java +public java.lang.String getEnforcementInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `rulesInput`Optional + +```java +public RepositoryRulesetRules getRulesInput(); +``` + +- *Type:* RepositoryRulesetRules + +--- + +##### `targetInput`Optional + +```java +public java.lang.String getTargetInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `enforcement`Required + +```java +public java.lang.String getEnforcement(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `target`Required + +```java +public java.lang.String getTarget(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### RepositoryRulesetBypassActors + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetBypassActors; + +RepositoryRulesetBypassActors.builder() + .actorType(java.lang.String) + .bypassMode(java.lang.String) +// .actorId(java.lang.Number) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| actorType | java.lang.String | The type of actor that can bypass a ruleset. See https://docs.github.com/en/rest/repos/rules for more information. | +| bypassMode | java.lang.String | When the specified actor can bypass the ruleset. | +| actorId | java.lang.Number | The ID of the actor that can bypass a ruleset. | + +--- + +##### `actorType`Required + +```java +public java.lang.String getActorType(); +``` + +- *Type:* java.lang.String + +The type of actor that can bypass a ruleset. See https://docs.github.com/en/rest/repos/rules for more information. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#actor_type RepositoryRuleset#actor_type} + +--- + +##### `bypassMode`Required + +```java +public java.lang.String getBypassMode(); +``` + +- *Type:* java.lang.String + +When the specified actor can bypass the ruleset. + +pull_request means that an actor can only bypass rules on pull requests. Can be one of: `always`, `pull_request`, `exempt`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#bypass_mode RepositoryRuleset#bypass_mode} + +--- + +##### `actorId`Optional + +```java +public java.lang.Number getActorId(); +``` + +- *Type:* java.lang.Number + +The ID of the actor that can bypass a ruleset. + +When `actor_type` is `OrganizationAdmin`, this should be set to `1`. Some resources such as DeployKey do not have an ID and this should be omitted. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#actor_id RepositoryRuleset#actor_id} + +--- + +### RepositoryRulesetConditions + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetConditions; + +RepositoryRulesetConditions.builder() + .refName(RepositoryRulesetConditionsRefName) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| refName | RepositoryRulesetConditionsRefName | ref_name block. | + +--- + +##### `refName`Required + +```java +public RepositoryRulesetConditionsRefName getRefName(); +``` + +- *Type:* RepositoryRulesetConditionsRefName + +ref_name block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#ref_name RepositoryRuleset#ref_name} + +--- + +### RepositoryRulesetConditionsRefName + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetConditionsRefName; + +RepositoryRulesetConditionsRefName.builder() + .exclude(java.util.List) + .include(java.util.List) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| exclude | java.util.List | Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. | +| include | java.util.List | Array of ref names or patterns to include. | + +--- + +##### `exclude`Required + +```java +public java.util.List getExclude(); +``` + +- *Type:* java.util.List + +Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#exclude RepositoryRuleset#exclude} + +--- + +##### `include`Required + +```java +public java.util.List getInclude(); +``` + +- *Type:* java.util.List + +Array of ref names or patterns to include. + +One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#include RepositoryRuleset#include} + +--- + +### RepositoryRulesetConfig + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetConfig; + +RepositoryRulesetConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .enforcement(java.lang.String) + .name(java.lang.String) + .repository(java.lang.String) + .rules(RepositoryRulesetRules) + .target(java.lang.String) +// .bypassActors(IResolvable|java.util.List) +// .conditions(RepositoryRulesetConditions) +// .id(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 | *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 | *No description.* | +| enforcement | java.lang.String | Possible values for Enforcement are `disabled`, `active`, `evaluate`. Note: `evaluate` is currently only supported for owners of type `organization`. | +| name | java.lang.String | The name of the ruleset. | +| repository | java.lang.String | Name of the repository to apply ruleset to. | +| rules | RepositoryRulesetRules | rules block. | +| target | java.lang.String | Possible values are branch, push and tag. | +| bypassActors | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryRulesetBypassActors> | bypass_actors block. | +| conditions | RepositoryRulesetConditions | conditions block. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#id RepositoryRuleset#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `enforcement`Required + +```java +public java.lang.String getEnforcement(); +``` + +- *Type:* java.lang.String + +Possible values for Enforcement are `disabled`, `active`, `evaluate`. Note: `evaluate` is currently only supported for owners of type `organization`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#enforcement RepositoryRuleset#enforcement} + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +The name of the ruleset. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#name RepositoryRuleset#name} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +Name of the repository to apply ruleset to. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#repository RepositoryRuleset#repository} + +--- + +##### `rules`Required + +```java +public RepositoryRulesetRules getRules(); +``` + +- *Type:* RepositoryRulesetRules + +rules block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#rules RepositoryRuleset#rules} + +--- + +##### `target`Required + +```java +public java.lang.String getTarget(); +``` + +- *Type:* java.lang.String + +Possible values are branch, push and tag. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#target RepositoryRuleset#target} + +--- + +##### `bypassActors`Optional + +```java +public IResolvable|java.util.List getBypassActors(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryRulesetBypassActors> + +bypass_actors block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#bypass_actors RepositoryRuleset#bypass_actors} + +--- + +##### `conditions`Optional + +```java +public RepositoryRulesetConditions getConditions(); +``` + +- *Type:* RepositoryRulesetConditions + +conditions block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#conditions RepositoryRuleset#conditions} + +--- + +##### `id`Optional + +```java +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/resources/repository_ruleset#id RepositoryRuleset#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. + +--- + +### RepositoryRulesetRules + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRules; + +RepositoryRulesetRules.builder() +// .branchNamePattern(RepositoryRulesetRulesBranchNamePattern) +// .commitAuthorEmailPattern(RepositoryRulesetRulesCommitAuthorEmailPattern) +// .commitMessagePattern(RepositoryRulesetRulesCommitMessagePattern) +// .committerEmailPattern(RepositoryRulesetRulesCommitterEmailPattern) +// .copilotCodeReview(RepositoryRulesetRulesCopilotCodeReview) +// .creation(java.lang.Boolean|IResolvable) +// .deletion(java.lang.Boolean|IResolvable) +// .fileExtensionRestriction(RepositoryRulesetRulesFileExtensionRestriction) +// .filePathRestriction(RepositoryRulesetRulesFilePathRestriction) +// .maxFilePathLength(RepositoryRulesetRulesMaxFilePathLength) +// .maxFileSize(RepositoryRulesetRulesMaxFileSize) +// .mergeQueue(RepositoryRulesetRulesMergeQueue) +// .nonFastForward(java.lang.Boolean|IResolvable) +// .pullRequest(RepositoryRulesetRulesPullRequest) +// .requiredCodeScanning(RepositoryRulesetRulesRequiredCodeScanning) +// .requiredDeployments(RepositoryRulesetRulesRequiredDeployments) +// .requiredLinearHistory(java.lang.Boolean|IResolvable) +// .requiredSignatures(java.lang.Boolean|IResolvable) +// .requiredStatusChecks(RepositoryRulesetRulesRequiredStatusChecks) +// .tagNamePattern(RepositoryRulesetRulesTagNamePattern) +// .update(java.lang.Boolean|IResolvable) +// .updateAllowsFetchAndMerge(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| branchNamePattern | RepositoryRulesetRulesBranchNamePattern | branch_name_pattern block. | +| commitAuthorEmailPattern | RepositoryRulesetRulesCommitAuthorEmailPattern | commit_author_email_pattern block. | +| commitMessagePattern | RepositoryRulesetRulesCommitMessagePattern | commit_message_pattern block. | +| committerEmailPattern | RepositoryRulesetRulesCommitterEmailPattern | committer_email_pattern block. | +| copilotCodeReview | RepositoryRulesetRulesCopilotCodeReview | copilot_code_review block. | +| creation | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Only allow users with bypass permission to create matching refs. | +| deletion | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Only allow users with bypass permissions to delete matching refs. | +| fileExtensionRestriction | RepositoryRulesetRulesFileExtensionRestriction | file_extension_restriction block. | +| filePathRestriction | RepositoryRulesetRulesFilePathRestriction | file_path_restriction block. | +| maxFilePathLength | RepositoryRulesetRulesMaxFilePathLength | max_file_path_length block. | +| maxFileSize | RepositoryRulesetRulesMaxFileSize | max_file_size block. | +| mergeQueue | RepositoryRulesetRulesMergeQueue | merge_queue block. | +| nonFastForward | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Prevent users with push access from force pushing to branches. | +| pullRequest | RepositoryRulesetRulesPullRequest | pull_request block. | +| requiredCodeScanning | RepositoryRulesetRulesRequiredCodeScanning | required_code_scanning block. | +| requiredDeployments | RepositoryRulesetRulesRequiredDeployments | required_deployments block. | +| requiredLinearHistory | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Prevent merge commits from being pushed to matching branches. | +| requiredSignatures | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Commits pushed to matching branches must have verified signatures. | +| requiredStatusChecks | RepositoryRulesetRulesRequiredStatusChecks | required_status_checks block. | +| tagNamePattern | RepositoryRulesetRulesTagNamePattern | tag_name_pattern block. | +| update | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Only allow users with bypass permission to update matching refs. | +| updateAllowsFetchAndMerge | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Branch can pull changes from its upstream repository. | + +--- + +##### `branchNamePattern`Optional + +```java +public RepositoryRulesetRulesBranchNamePattern getBranchNamePattern(); +``` + +- *Type:* RepositoryRulesetRulesBranchNamePattern + +branch_name_pattern block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#branch_name_pattern RepositoryRuleset#branch_name_pattern} + +--- + +##### `commitAuthorEmailPattern`Optional + +```java +public RepositoryRulesetRulesCommitAuthorEmailPattern getCommitAuthorEmailPattern(); +``` + +- *Type:* RepositoryRulesetRulesCommitAuthorEmailPattern + +commit_author_email_pattern block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#commit_author_email_pattern RepositoryRuleset#commit_author_email_pattern} + +--- + +##### `commitMessagePattern`Optional + +```java +public RepositoryRulesetRulesCommitMessagePattern getCommitMessagePattern(); +``` + +- *Type:* RepositoryRulesetRulesCommitMessagePattern + +commit_message_pattern block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#commit_message_pattern RepositoryRuleset#commit_message_pattern} + +--- + +##### `committerEmailPattern`Optional + +```java +public RepositoryRulesetRulesCommitterEmailPattern getCommitterEmailPattern(); +``` + +- *Type:* RepositoryRulesetRulesCommitterEmailPattern + +committer_email_pattern block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#committer_email_pattern RepositoryRuleset#committer_email_pattern} + +--- + +##### `copilotCodeReview`Optional + +```java +public RepositoryRulesetRulesCopilotCodeReview getCopilotCodeReview(); +``` + +- *Type:* RepositoryRulesetRulesCopilotCodeReview + +copilot_code_review block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#copilot_code_review RepositoryRuleset#copilot_code_review} + +--- + +##### `creation`Optional + +```java +public java.lang.Boolean|IResolvable getCreation(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Only allow users with bypass permission to create matching refs. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#creation RepositoryRuleset#creation} + +--- + +##### `deletion`Optional + +```java +public java.lang.Boolean|IResolvable getDeletion(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Only allow users with bypass permissions to delete matching refs. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#deletion RepositoryRuleset#deletion} + +--- + +##### `fileExtensionRestriction`Optional + +```java +public RepositoryRulesetRulesFileExtensionRestriction getFileExtensionRestriction(); +``` + +- *Type:* RepositoryRulesetRulesFileExtensionRestriction + +file_extension_restriction block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#file_extension_restriction RepositoryRuleset#file_extension_restriction} + +--- + +##### `filePathRestriction`Optional + +```java +public RepositoryRulesetRulesFilePathRestriction getFilePathRestriction(); +``` + +- *Type:* RepositoryRulesetRulesFilePathRestriction + +file_path_restriction block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#file_path_restriction RepositoryRuleset#file_path_restriction} + +--- + +##### `maxFilePathLength`Optional + +```java +public RepositoryRulesetRulesMaxFilePathLength getMaxFilePathLength(); +``` + +- *Type:* RepositoryRulesetRulesMaxFilePathLength + +max_file_path_length block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#max_file_path_length RepositoryRuleset#max_file_path_length} + +--- + +##### `maxFileSize`Optional + +```java +public RepositoryRulesetRulesMaxFileSize getMaxFileSize(); +``` + +- *Type:* RepositoryRulesetRulesMaxFileSize + +max_file_size block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#max_file_size RepositoryRuleset#max_file_size} + +--- + +##### `mergeQueue`Optional + +```java +public RepositoryRulesetRulesMergeQueue getMergeQueue(); +``` + +- *Type:* RepositoryRulesetRulesMergeQueue + +merge_queue block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#merge_queue RepositoryRuleset#merge_queue} + +--- + +##### `nonFastForward`Optional + +```java +public java.lang.Boolean|IResolvable getNonFastForward(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Prevent users with push access from force pushing to branches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#non_fast_forward RepositoryRuleset#non_fast_forward} + +--- + +##### `pullRequest`Optional + +```java +public RepositoryRulesetRulesPullRequest getPullRequest(); +``` + +- *Type:* RepositoryRulesetRulesPullRequest + +pull_request block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#pull_request RepositoryRuleset#pull_request} + +--- + +##### `requiredCodeScanning`Optional + +```java +public RepositoryRulesetRulesRequiredCodeScanning getRequiredCodeScanning(); +``` + +- *Type:* RepositoryRulesetRulesRequiredCodeScanning + +required_code_scanning block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#required_code_scanning RepositoryRuleset#required_code_scanning} + +--- + +##### `requiredDeployments`Optional + +```java +public RepositoryRulesetRulesRequiredDeployments getRequiredDeployments(); +``` + +- *Type:* RepositoryRulesetRulesRequiredDeployments + +required_deployments block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#required_deployments RepositoryRuleset#required_deployments} + +--- + +##### `requiredLinearHistory`Optional + +```java +public java.lang.Boolean|IResolvable getRequiredLinearHistory(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Prevent merge commits from being pushed to matching branches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#required_linear_history RepositoryRuleset#required_linear_history} + +--- + +##### `requiredSignatures`Optional + +```java +public java.lang.Boolean|IResolvable getRequiredSignatures(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Commits pushed to matching branches must have verified signatures. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#required_signatures RepositoryRuleset#required_signatures} + +--- + +##### `requiredStatusChecks`Optional + +```java +public RepositoryRulesetRulesRequiredStatusChecks getRequiredStatusChecks(); +``` + +- *Type:* RepositoryRulesetRulesRequiredStatusChecks + +required_status_checks block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#required_status_checks RepositoryRuleset#required_status_checks} + +--- + +##### `tagNamePattern`Optional + +```java +public RepositoryRulesetRulesTagNamePattern getTagNamePattern(); +``` + +- *Type:* RepositoryRulesetRulesTagNamePattern + +tag_name_pattern block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#tag_name_pattern RepositoryRuleset#tag_name_pattern} + +--- + +##### `update`Optional + +```java +public java.lang.Boolean|IResolvable getUpdate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Only allow users with bypass permission to update matching refs. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#update RepositoryRuleset#update} + +--- + +##### `updateAllowsFetchAndMerge`Optional + +```java +public java.lang.Boolean|IResolvable getUpdateAllowsFetchAndMerge(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Branch can pull changes from its upstream repository. + +This is only applicable to forked repositories. Requires `update` to be set to `true`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#update_allows_fetch_and_merge RepositoryRuleset#update_allows_fetch_and_merge} + +--- + +### RepositoryRulesetRulesBranchNamePattern + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesBranchNamePattern; + +RepositoryRulesetRulesBranchNamePattern.builder() + .operator(java.lang.String) + .pattern(java.lang.String) +// .name(java.lang.String) +// .negate(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| operator | java.lang.String | The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. | +| pattern | java.lang.String | The pattern to match with. | +| name | java.lang.String | How this rule will appear to users. | +| negate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | If true, the rule will fail if the pattern matches. | + +--- + +##### `operator`Required + +```java +public java.lang.String getOperator(); +``` + +- *Type:* java.lang.String + +The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#operator RepositoryRuleset#operator} + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +The pattern to match with. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#pattern RepositoryRuleset#pattern} + +--- + +##### `name`Optional + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +How this rule will appear to users. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#name RepositoryRuleset#name} + +--- + +##### `negate`Optional + +```java +public java.lang.Boolean|IResolvable getNegate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +If true, the rule will fail if the pattern matches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#negate RepositoryRuleset#negate} + +--- + +### RepositoryRulesetRulesCommitAuthorEmailPattern + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesCommitAuthorEmailPattern; + +RepositoryRulesetRulesCommitAuthorEmailPattern.builder() + .operator(java.lang.String) + .pattern(java.lang.String) +// .name(java.lang.String) +// .negate(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| operator | java.lang.String | The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. | +| pattern | java.lang.String | The pattern to match with. | +| name | java.lang.String | How this rule will appear to users. | +| negate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | If true, the rule will fail if the pattern matches. | + +--- + +##### `operator`Required + +```java +public java.lang.String getOperator(); +``` + +- *Type:* java.lang.String + +The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#operator RepositoryRuleset#operator} + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +The pattern to match with. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#pattern RepositoryRuleset#pattern} + +--- + +##### `name`Optional + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +How this rule will appear to users. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#name RepositoryRuleset#name} + +--- + +##### `negate`Optional + +```java +public java.lang.Boolean|IResolvable getNegate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +If true, the rule will fail if the pattern matches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#negate RepositoryRuleset#negate} + +--- + +### RepositoryRulesetRulesCommitMessagePattern + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesCommitMessagePattern; + +RepositoryRulesetRulesCommitMessagePattern.builder() + .operator(java.lang.String) + .pattern(java.lang.String) +// .name(java.lang.String) +// .negate(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| operator | java.lang.String | The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. | +| pattern | java.lang.String | The pattern to match with. | +| name | java.lang.String | How this rule will appear to users. | +| negate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | If true, the rule will fail if the pattern matches. | + +--- + +##### `operator`Required + +```java +public java.lang.String getOperator(); +``` + +- *Type:* java.lang.String + +The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#operator RepositoryRuleset#operator} + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +The pattern to match with. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#pattern RepositoryRuleset#pattern} + +--- + +##### `name`Optional + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +How this rule will appear to users. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#name RepositoryRuleset#name} + +--- + +##### `negate`Optional + +```java +public java.lang.Boolean|IResolvable getNegate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +If true, the rule will fail if the pattern matches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#negate RepositoryRuleset#negate} + +--- + +### RepositoryRulesetRulesCommitterEmailPattern + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesCommitterEmailPattern; + +RepositoryRulesetRulesCommitterEmailPattern.builder() + .operator(java.lang.String) + .pattern(java.lang.String) +// .name(java.lang.String) +// .negate(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| operator | java.lang.String | The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. | +| pattern | java.lang.String | The pattern to match with. | +| name | java.lang.String | How this rule will appear to users. | +| negate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | If true, the rule will fail if the pattern matches. | + +--- + +##### `operator`Required + +```java +public java.lang.String getOperator(); +``` + +- *Type:* java.lang.String + +The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#operator RepositoryRuleset#operator} + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +The pattern to match with. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#pattern RepositoryRuleset#pattern} + +--- + +##### `name`Optional + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +How this rule will appear to users. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#name RepositoryRuleset#name} + +--- + +##### `negate`Optional + +```java +public java.lang.Boolean|IResolvable getNegate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +If true, the rule will fail if the pattern matches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#negate RepositoryRuleset#negate} + +--- + +### RepositoryRulesetRulesCopilotCodeReview + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesCopilotCodeReview; + +RepositoryRulesetRulesCopilotCodeReview.builder() +// .reviewDraftPullRequests(java.lang.Boolean|IResolvable) +// .reviewOnPush(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| reviewDraftPullRequests | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Copilot automatically reviews draft pull requests before they are marked as ready for review. Defaults to `false`. | +| reviewOnPush | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Copilot automatically reviews each new push to the pull request. Defaults to `false`. | + +--- + +##### `reviewDraftPullRequests`Optional + +```java +public java.lang.Boolean|IResolvable getReviewDraftPullRequests(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Copilot automatically reviews draft pull requests before they are marked as ready for review. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#review_draft_pull_requests RepositoryRuleset#review_draft_pull_requests} + +--- + +##### `reviewOnPush`Optional + +```java +public java.lang.Boolean|IResolvable getReviewOnPush(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Copilot automatically reviews each new push to the pull request. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#review_on_push RepositoryRuleset#review_on_push} + +--- + +### RepositoryRulesetRulesFileExtensionRestriction + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesFileExtensionRestriction; + +RepositoryRulesetRulesFileExtensionRestriction.builder() + .restrictedFileExtensions(java.util.List) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| restrictedFileExtensions | java.util.List | A list of file extensions. | + +--- + +##### `restrictedFileExtensions`Required + +```java +public java.util.List getRestrictedFileExtensions(); +``` + +- *Type:* java.util.List + +A list of file extensions. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#restricted_file_extensions RepositoryRuleset#restricted_file_extensions} + +--- + +### RepositoryRulesetRulesFilePathRestriction + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesFilePathRestriction; + +RepositoryRulesetRulesFilePathRestriction.builder() + .restrictedFilePaths(java.util.List) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| restrictedFilePaths | java.util.List | The file paths that are restricted from being pushed to the commit graph. | + +--- + +##### `restrictedFilePaths`Required + +```java +public java.util.List getRestrictedFilePaths(); +``` + +- *Type:* java.util.List + +The file paths that are restricted from being pushed to the commit graph. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#restricted_file_paths RepositoryRuleset#restricted_file_paths} + +--- + +### RepositoryRulesetRulesMaxFilePathLength + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesMaxFilePathLength; + +RepositoryRulesetRulesMaxFilePathLength.builder() + .maxFilePathLength(java.lang.Number) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| maxFilePathLength | java.lang.Number | The maximum allowed length of a file path. | + +--- + +##### `maxFilePathLength`Required + +```java +public java.lang.Number getMaxFilePathLength(); +``` + +- *Type:* java.lang.Number + +The maximum allowed length of a file path. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#max_file_path_length RepositoryRuleset#max_file_path_length} + +--- + +### RepositoryRulesetRulesMaxFileSize + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesMaxFileSize; + +RepositoryRulesetRulesMaxFileSize.builder() + .maxFileSize(java.lang.Number) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| maxFileSize | java.lang.Number | The maximum allowed size of a file in megabytes (MB). Valid range is 1-100 MB. | + +--- + +##### `maxFileSize`Required + +```java +public java.lang.Number getMaxFileSize(); +``` + +- *Type:* java.lang.Number + +The maximum allowed size of a file in megabytes (MB). Valid range is 1-100 MB. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#max_file_size RepositoryRuleset#max_file_size} + +--- + +### RepositoryRulesetRulesMergeQueue + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesMergeQueue; + +RepositoryRulesetRulesMergeQueue.builder() +// .checkResponseTimeoutMinutes(java.lang.Number) +// .groupingStrategy(java.lang.String) +// .maxEntriesToBuild(java.lang.Number) +// .maxEntriesToMerge(java.lang.Number) +// .mergeMethod(java.lang.String) +// .minEntriesToMerge(java.lang.Number) +// .minEntriesToMergeWaitMinutes(java.lang.Number) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| checkResponseTimeoutMinutes | java.lang.Number | Maximum time for a required status check to report a conclusion. | +| groupingStrategy | java.lang.String | When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. | +| maxEntriesToBuild | java.lang.Number | Limit the number of queued pull requests requesting checks and workflow runs at the same time. Defaults to `5`. | +| maxEntriesToMerge | java.lang.Number | The maximum number of PRs that will be merged together in a group. Defaults to `5`. | +| mergeMethod | java.lang.String | Method to use when merging changes from queued pull requests. | +| minEntriesToMerge | java.lang.Number | The minimum number of PRs that will be merged together in a group. Defaults to `1`. | +| minEntriesToMergeWaitMinutes | java.lang.Number | The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. | + +--- + +##### `checkResponseTimeoutMinutes`Optional + +```java +public java.lang.Number getCheckResponseTimeoutMinutes(); +``` + +- *Type:* java.lang.Number + +Maximum time for a required status check to report a conclusion. + +After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed. Defaults to `60`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#check_response_timeout_minutes RepositoryRuleset#check_response_timeout_minutes} + +--- + +##### `groupingStrategy`Optional + +```java +public java.lang.String getGroupingStrategy(); +``` + +- *Type:* java.lang.String + +When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. + +When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. Can be one of: ALLGREEN, HEADGREEN. Defaults to `ALLGREEN`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#grouping_strategy RepositoryRuleset#grouping_strategy} + +--- + +##### `maxEntriesToBuild`Optional + +```java +public java.lang.Number getMaxEntriesToBuild(); +``` + +- *Type:* java.lang.Number + +Limit the number of queued pull requests requesting checks and workflow runs at the same time. Defaults to `5`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#max_entries_to_build RepositoryRuleset#max_entries_to_build} + +--- + +##### `maxEntriesToMerge`Optional + +```java +public java.lang.Number getMaxEntriesToMerge(); +``` + +- *Type:* java.lang.Number + +The maximum number of PRs that will be merged together in a group. Defaults to `5`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#max_entries_to_merge RepositoryRuleset#max_entries_to_merge} + +--- + +##### `mergeMethod`Optional + +```java +public java.lang.String getMergeMethod(); +``` + +- *Type:* java.lang.String + +Method to use when merging changes from queued pull requests. + +Can be one of: MERGE, SQUASH, REBASE. Defaults to `MERGE`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#merge_method RepositoryRuleset#merge_method} + +--- + +##### `minEntriesToMerge`Optional + +```java +public java.lang.Number getMinEntriesToMerge(); +``` + +- *Type:* java.lang.Number + +The minimum number of PRs that will be merged together in a group. Defaults to `1`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#min_entries_to_merge RepositoryRuleset#min_entries_to_merge} + +--- + +##### `minEntriesToMergeWaitMinutes`Optional + +```java +public java.lang.Number getMinEntriesToMergeWaitMinutes(); +``` + +- *Type:* java.lang.Number + +The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. + +After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. Defaults to `5`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#min_entries_to_merge_wait_minutes RepositoryRuleset#min_entries_to_merge_wait_minutes} + +--- + +### RepositoryRulesetRulesPullRequest + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesPullRequest; + +RepositoryRulesetRulesPullRequest.builder() +// .allowedMergeMethods(java.util.List) +// .dismissStaleReviewsOnPush(java.lang.Boolean|IResolvable) +// .requireCodeOwnerReview(java.lang.Boolean|IResolvable) +// .requiredApprovingReviewCount(java.lang.Number) +// .requiredReviewers(IResolvable|java.util.List) +// .requiredReviewThreadResolution(java.lang.Boolean|IResolvable) +// .requireLastPushApproval(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| allowedMergeMethods | java.util.List | Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled. | +| dismissStaleReviewsOnPush | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | New, reviewable commits pushed will dismiss previous pull request review approvals. Defaults to `false`. | +| requireCodeOwnerReview | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Require an approving review in pull requests that modify files that have a designated code owner. Defaults to `false`. | +| requiredApprovingReviewCount | java.lang.Number | The number of approving reviews that are required before a pull request can be merged. Defaults to `0`. | +| requiredReviewers | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryRulesetRulesPullRequestRequiredReviewers> | required_reviewers block. | +| requiredReviewThreadResolution | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | All conversations on code must be resolved before a pull request can be merged. Defaults to `false`. | +| requireLastPushApproval | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether the most recent reviewable push must be approved by someone other than the person who pushed it. | + +--- + +##### `allowedMergeMethods`Optional + +```java +public java.util.List getAllowedMergeMethods(); +``` + +- *Type:* java.util.List + +Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#allowed_merge_methods RepositoryRuleset#allowed_merge_methods} + +--- + +##### `dismissStaleReviewsOnPush`Optional + +```java +public java.lang.Boolean|IResolvable getDismissStaleReviewsOnPush(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +New, reviewable commits pushed will dismiss previous pull request review approvals. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#dismiss_stale_reviews_on_push RepositoryRuleset#dismiss_stale_reviews_on_push} + +--- + +##### `requireCodeOwnerReview`Optional + +```java +public java.lang.Boolean|IResolvable getRequireCodeOwnerReview(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Require an approving review in pull requests that modify files that have a designated code owner. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#require_code_owner_review RepositoryRuleset#require_code_owner_review} + +--- + +##### `requiredApprovingReviewCount`Optional + +```java +public java.lang.Number getRequiredApprovingReviewCount(); +``` + +- *Type:* java.lang.Number + +The number of approving reviews that are required before a pull request can be merged. Defaults to `0`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#required_approving_review_count RepositoryRuleset#required_approving_review_count} + +--- + +##### `requiredReviewers`Optional + +```java +public IResolvable|java.util.List getRequiredReviewers(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryRulesetRulesPullRequestRequiredReviewers> + +required_reviewers block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#required_reviewers RepositoryRuleset#required_reviewers} + +--- + +##### `requiredReviewThreadResolution`Optional + +```java +public java.lang.Boolean|IResolvable getRequiredReviewThreadResolution(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +All conversations on code must be resolved before a pull request can be merged. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#required_review_thread_resolution RepositoryRuleset#required_review_thread_resolution} + +--- + +##### `requireLastPushApproval`Optional + +```java +public java.lang.Boolean|IResolvable getRequireLastPushApproval(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether the most recent reviewable push must be approved by someone other than the person who pushed it. + +Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#require_last_push_approval RepositoryRuleset#require_last_push_approval} + +--- + +### RepositoryRulesetRulesPullRequestRequiredReviewers + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesPullRequestRequiredReviewers; + +RepositoryRulesetRulesPullRequestRequiredReviewers.builder() + .filePatterns(java.util.List) + .minimumApprovals(java.lang.Number) + .reviewer(RepositoryRulesetRulesPullRequestRequiredReviewersReviewer) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| filePatterns | java.util.List | File patterns (fnmatch syntax) that this reviewer must approve. | +| minimumApprovals | java.lang.Number | Minimum number of approvals required from this reviewer. Set to 0 to make approval optional. | +| reviewer | RepositoryRulesetRulesPullRequestRequiredReviewersReviewer | reviewer block. | + +--- + +##### `filePatterns`Required + +```java +public java.util.List getFilePatterns(); +``` + +- *Type:* java.util.List + +File patterns (fnmatch syntax) that this reviewer must approve. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#file_patterns RepositoryRuleset#file_patterns} + +--- + +##### `minimumApprovals`Required + +```java +public java.lang.Number getMinimumApprovals(); +``` + +- *Type:* java.lang.Number + +Minimum number of approvals required from this reviewer. Set to 0 to make approval optional. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#minimum_approvals RepositoryRuleset#minimum_approvals} + +--- + +##### `reviewer`Required + +```java +public RepositoryRulesetRulesPullRequestRequiredReviewersReviewer getReviewer(); +``` + +- *Type:* RepositoryRulesetRulesPullRequestRequiredReviewersReviewer + +reviewer block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#reviewer RepositoryRuleset#reviewer} + +--- + +### RepositoryRulesetRulesPullRequestRequiredReviewersReviewer + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesPullRequestRequiredReviewersReviewer; + +RepositoryRulesetRulesPullRequestRequiredReviewersReviewer.builder() + .id(java.lang.Number) + .type(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| id | java.lang.Number | The ID of the reviewer that must review. | +| type | java.lang.String | The type of reviewer. Currently only `Team` is supported. | + +--- + +##### `id`Required + +```java +public java.lang.Number getId(); +``` + +- *Type:* java.lang.Number + +The ID of the reviewer that must review. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#id RepositoryRuleset#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`Required + +```java +public java.lang.String getType(); +``` + +- *Type:* java.lang.String + +The type of reviewer. Currently only `Team` is supported. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#type RepositoryRuleset#type} + +--- + +### RepositoryRulesetRulesRequiredCodeScanning + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesRequiredCodeScanning; + +RepositoryRulesetRulesRequiredCodeScanning.builder() + .requiredCodeScanningTool(IResolvable|java.util.List) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| requiredCodeScanningTool | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool> | required_code_scanning_tool block. | + +--- + +##### `requiredCodeScanningTool`Required + +```java +public IResolvable|java.util.List getRequiredCodeScanningTool(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool> + +required_code_scanning_tool block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#required_code_scanning_tool RepositoryRuleset#required_code_scanning_tool} + +--- + +### RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool; + +RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool.builder() + .alertsThreshold(java.lang.String) + .securityAlertsThreshold(java.lang.String) + .tool(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| alertsThreshold | java.lang.String | The severity level at which code scanning results that raise alerts block a reference update. | +| securityAlertsThreshold | java.lang.String | The severity level at which code scanning results that raise security alerts block a reference update. | +| tool | java.lang.String | The name of a code scanning tool. | + +--- + +##### `alertsThreshold`Required + +```java +public java.lang.String getAlertsThreshold(); +``` + +- *Type:* java.lang.String + +The severity level at which code scanning results that raise alerts block a reference update. + +Can be one of: `none`, `errors`, `errors_and_warnings`, `all`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#alerts_threshold RepositoryRuleset#alerts_threshold} + +--- + +##### `securityAlertsThreshold`Required + +```java +public java.lang.String getSecurityAlertsThreshold(); +``` + +- *Type:* java.lang.String + +The severity level at which code scanning results that raise security alerts block a reference update. + +Can be one of: `none`, `critical`, `high_or_higher`, `medium_or_higher`, `all`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#security_alerts_threshold RepositoryRuleset#security_alerts_threshold} + +--- + +##### `tool`Required + +```java +public java.lang.String getTool(); +``` + +- *Type:* java.lang.String + +The name of a code scanning tool. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#tool RepositoryRuleset#tool} + +--- + +### RepositoryRulesetRulesRequiredDeployments + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesRequiredDeployments; + +RepositoryRulesetRulesRequiredDeployments.builder() + .requiredDeploymentEnvironments(java.util.List) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| requiredDeploymentEnvironments | java.util.List | The environments that must be successfully deployed to before branches can be merged. | + +--- + +##### `requiredDeploymentEnvironments`Required + +```java +public java.util.List getRequiredDeploymentEnvironments(); +``` + +- *Type:* java.util.List + +The environments that must be successfully deployed to before branches can be merged. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#required_deployment_environments RepositoryRuleset#required_deployment_environments} + +--- + +### RepositoryRulesetRulesRequiredStatusChecks + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesRequiredStatusChecks; + +RepositoryRulesetRulesRequiredStatusChecks.builder() + .requiredCheck(IResolvable|java.util.List) +// .doNotEnforceOnCreate(java.lang.Boolean|IResolvable) +// .strictRequiredStatusChecksPolicy(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| requiredCheck | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryRulesetRulesRequiredStatusChecksRequiredCheck> | required_check block. | +| doNotEnforceOnCreate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Allow repositories and branches to be created if a check would otherwise prohibit it. | +| strictRequiredStatusChecksPolicy | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether pull requests targeting a matching branch must be tested with the latest code. | + +--- + +##### `requiredCheck`Required + +```java +public IResolvable|java.util.List getRequiredCheck(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryRulesetRulesRequiredStatusChecksRequiredCheck> + +required_check block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#required_check RepositoryRuleset#required_check} + +--- + +##### `doNotEnforceOnCreate`Optional + +```java +public java.lang.Boolean|IResolvable getDoNotEnforceOnCreate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Allow repositories and branches to be created if a check would otherwise prohibit it. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#do_not_enforce_on_create RepositoryRuleset#do_not_enforce_on_create} + +--- + +##### `strictRequiredStatusChecksPolicy`Optional + +```java +public java.lang.Boolean|IResolvable getStrictRequiredStatusChecksPolicy(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether pull requests targeting a matching branch must be tested with the latest code. + +This setting will not take effect unless at least one status check is enabled. Defaults to `false`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#strict_required_status_checks_policy RepositoryRuleset#strict_required_status_checks_policy} + +--- + +### RepositoryRulesetRulesRequiredStatusChecksRequiredCheck + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesRequiredStatusChecksRequiredCheck; + +RepositoryRulesetRulesRequiredStatusChecksRequiredCheck.builder() + .context(java.lang.String) +// .integrationId(java.lang.Number) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| context | java.lang.String | The status check context name that must be present on the commit. | +| integrationId | java.lang.Number | The optional integration ID that this status check must originate from. | + +--- + +##### `context`Required + +```java +public java.lang.String getContext(); +``` + +- *Type:* java.lang.String + +The status check context name that must be present on the commit. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#context RepositoryRuleset#context} + +--- + +##### `integrationId`Optional + +```java +public java.lang.Number getIntegrationId(); +``` + +- *Type:* java.lang.Number + +The optional integration ID that this status check must originate from. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#integration_id RepositoryRuleset#integration_id} + +--- + +### RepositoryRulesetRulesTagNamePattern + +#### Initializer + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesTagNamePattern; + +RepositoryRulesetRulesTagNamePattern.builder() + .operator(java.lang.String) + .pattern(java.lang.String) +// .name(java.lang.String) +// .negate(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| operator | java.lang.String | The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. | +| pattern | java.lang.String | The pattern to match with. | +| name | java.lang.String | How this rule will appear to users. | +| negate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | If true, the rule will fail if the pattern matches. | + +--- + +##### `operator`Required + +```java +public java.lang.String getOperator(); +``` + +- *Type:* java.lang.String + +The operator to use for matching. Can be one of: `starts_with`, `ends_with`, `contains`, `regex`. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#operator RepositoryRuleset#operator} + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +The pattern to match with. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#pattern RepositoryRuleset#pattern} + +--- + +##### `name`Optional + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +How this rule will appear to users. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#name RepositoryRuleset#name} + +--- + +##### `negate`Optional + +```java +public java.lang.Boolean|IResolvable getNegate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +If true, the rule will fail if the pattern matches. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_ruleset#negate RepositoryRuleset#negate} + +--- + +## Classes + +### RepositoryRulesetBypassActorsList + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetBypassActorsList; + +new RepositoryRulesetBypassActorsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public RepositoryRulesetBypassActorsOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryRulesetBypassActors> | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|java.util.List getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryRulesetBypassActors> + +--- + + +### RepositoryRulesetBypassActorsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetBypassActorsOutputReference; + +new RepositoryRulesetBypassActorsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetActorId | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetActorId` + +```java +public void resetActorId() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| actorIdInput | java.lang.Number | *No description.* | +| actorTypeInput | java.lang.String | *No description.* | +| bypassModeInput | java.lang.String | *No description.* | +| actorId | java.lang.Number | *No description.* | +| actorType | java.lang.String | *No description.* | +| bypassMode | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|RepositoryRulesetBypassActors | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `actorIdInput`Optional + +```java +public java.lang.Number getActorIdInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `actorTypeInput`Optional + +```java +public java.lang.String getActorTypeInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `bypassModeInput`Optional + +```java +public java.lang.String getBypassModeInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `actorId`Required + +```java +public java.lang.Number getActorId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `actorType`Required + +```java +public java.lang.String getActorType(); +``` + +- *Type:* java.lang.String + +--- + +##### `bypassMode`Required + +```java +public java.lang.String getBypassMode(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|RepositoryRulesetBypassActors getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|RepositoryRulesetBypassActors + +--- + + +### RepositoryRulesetConditionsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetConditionsOutputReference; + +new RepositoryRulesetConditionsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| putRefName | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `putRefName` + +```java +public void putRefName(RepositoryRulesetConditionsRefName value) +``` + +###### `value`Required + +- *Type:* RepositoryRulesetConditionsRefName + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| refName | RepositoryRulesetConditionsRefNameOutputReference | *No description.* | +| refNameInput | RepositoryRulesetConditionsRefName | *No description.* | +| internalValue | RepositoryRulesetConditions | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `refName`Required + +```java +public RepositoryRulesetConditionsRefNameOutputReference getRefName(); +``` + +- *Type:* RepositoryRulesetConditionsRefNameOutputReference + +--- + +##### `refNameInput`Optional + +```java +public RepositoryRulesetConditionsRefName getRefNameInput(); +``` + +- *Type:* RepositoryRulesetConditionsRefName + +--- + +##### `internalValue`Optional + +```java +public RepositoryRulesetConditions getInternalValue(); +``` + +- *Type:* RepositoryRulesetConditions + +--- + + +### RepositoryRulesetConditionsRefNameOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetConditionsRefNameOutputReference; + +new RepositoryRulesetConditionsRefNameOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| excludeInput | java.util.List | *No description.* | +| includeInput | java.util.List | *No description.* | +| exclude | java.util.List | *No description.* | +| include | java.util.List | *No description.* | +| internalValue | RepositoryRulesetConditionsRefName | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `excludeInput`Optional + +```java +public java.util.List getExcludeInput(); +``` + +- *Type:* java.util.List + +--- + +##### `includeInput`Optional + +```java +public java.util.List getIncludeInput(); +``` + +- *Type:* java.util.List + +--- + +##### `exclude`Required + +```java +public java.util.List getExclude(); +``` + +- *Type:* java.util.List + +--- + +##### `include`Required + +```java +public java.util.List getInclude(); +``` + +- *Type:* java.util.List + +--- + +##### `internalValue`Optional + +```java +public RepositoryRulesetConditionsRefName getInternalValue(); +``` + +- *Type:* RepositoryRulesetConditionsRefName + +--- + + +### RepositoryRulesetRulesBranchNamePatternOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesBranchNamePatternOutputReference; + +new RepositoryRulesetRulesBranchNamePatternOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetName | *No description.* | +| resetNegate | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetName` + +```java +public void resetName() +``` + +##### `resetNegate` + +```java +public void resetNegate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| negateInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| operatorInput | java.lang.String | *No description.* | +| patternInput | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| negate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| operator | java.lang.String | *No description.* | +| pattern | java.lang.String | *No description.* | +| internalValue | RepositoryRulesetRulesBranchNamePattern | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `negateInput`Optional + +```java +public java.lang.Boolean|IResolvable getNegateInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `operatorInput`Optional + +```java +public java.lang.String getOperatorInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `patternInput`Optional + +```java +public java.lang.String getPatternInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `negate`Required + +```java +public java.lang.Boolean|IResolvable getNegate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `operator`Required + +```java +public java.lang.String getOperator(); +``` + +- *Type:* java.lang.String + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public RepositoryRulesetRulesBranchNamePattern getInternalValue(); +``` + +- *Type:* RepositoryRulesetRulesBranchNamePattern + +--- + + +### RepositoryRulesetRulesCommitAuthorEmailPatternOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesCommitAuthorEmailPatternOutputReference; + +new RepositoryRulesetRulesCommitAuthorEmailPatternOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetName | *No description.* | +| resetNegate | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetName` + +```java +public void resetName() +``` + +##### `resetNegate` + +```java +public void resetNegate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| negateInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| operatorInput | java.lang.String | *No description.* | +| patternInput | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| negate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| operator | java.lang.String | *No description.* | +| pattern | java.lang.String | *No description.* | +| internalValue | RepositoryRulesetRulesCommitAuthorEmailPattern | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `negateInput`Optional + +```java +public java.lang.Boolean|IResolvable getNegateInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `operatorInput`Optional + +```java +public java.lang.String getOperatorInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `patternInput`Optional + +```java +public java.lang.String getPatternInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `negate`Required + +```java +public java.lang.Boolean|IResolvable getNegate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `operator`Required + +```java +public java.lang.String getOperator(); +``` + +- *Type:* java.lang.String + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public RepositoryRulesetRulesCommitAuthorEmailPattern getInternalValue(); +``` + +- *Type:* RepositoryRulesetRulesCommitAuthorEmailPattern + +--- + + +### RepositoryRulesetRulesCommitMessagePatternOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesCommitMessagePatternOutputReference; + +new RepositoryRulesetRulesCommitMessagePatternOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetName | *No description.* | +| resetNegate | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetName` + +```java +public void resetName() +``` + +##### `resetNegate` + +```java +public void resetNegate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| negateInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| operatorInput | java.lang.String | *No description.* | +| patternInput | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| negate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| operator | java.lang.String | *No description.* | +| pattern | java.lang.String | *No description.* | +| internalValue | RepositoryRulesetRulesCommitMessagePattern | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `negateInput`Optional + +```java +public java.lang.Boolean|IResolvable getNegateInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `operatorInput`Optional + +```java +public java.lang.String getOperatorInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `patternInput`Optional + +```java +public java.lang.String getPatternInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `negate`Required + +```java +public java.lang.Boolean|IResolvable getNegate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `operator`Required + +```java +public java.lang.String getOperator(); +``` + +- *Type:* java.lang.String + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public RepositoryRulesetRulesCommitMessagePattern getInternalValue(); +``` + +- *Type:* RepositoryRulesetRulesCommitMessagePattern + +--- + + +### RepositoryRulesetRulesCommitterEmailPatternOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesCommitterEmailPatternOutputReference; + +new RepositoryRulesetRulesCommitterEmailPatternOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetName | *No description.* | +| resetNegate | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetName` + +```java +public void resetName() +``` + +##### `resetNegate` + +```java +public void resetNegate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| negateInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| operatorInput | java.lang.String | *No description.* | +| patternInput | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| negate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| operator | java.lang.String | *No description.* | +| pattern | java.lang.String | *No description.* | +| internalValue | RepositoryRulesetRulesCommitterEmailPattern | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `negateInput`Optional + +```java +public java.lang.Boolean|IResolvable getNegateInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `operatorInput`Optional + +```java +public java.lang.String getOperatorInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `patternInput`Optional + +```java +public java.lang.String getPatternInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `negate`Required + +```java +public java.lang.Boolean|IResolvable getNegate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `operator`Required + +```java +public java.lang.String getOperator(); +``` + +- *Type:* java.lang.String + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public RepositoryRulesetRulesCommitterEmailPattern getInternalValue(); +``` + +- *Type:* RepositoryRulesetRulesCommitterEmailPattern + +--- + + +### RepositoryRulesetRulesCopilotCodeReviewOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesCopilotCodeReviewOutputReference; + +new RepositoryRulesetRulesCopilotCodeReviewOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetReviewDraftPullRequests | *No description.* | +| resetReviewOnPush | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetReviewDraftPullRequests` + +```java +public void resetReviewDraftPullRequests() +``` + +##### `resetReviewOnPush` + +```java +public void resetReviewOnPush() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| reviewDraftPullRequestsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| reviewOnPushInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| reviewDraftPullRequests | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| reviewOnPush | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| internalValue | RepositoryRulesetRulesCopilotCodeReview | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `reviewDraftPullRequestsInput`Optional + +```java +public java.lang.Boolean|IResolvable getReviewDraftPullRequestsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `reviewOnPushInput`Optional + +```java +public java.lang.Boolean|IResolvable getReviewOnPushInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `reviewDraftPullRequests`Required + +```java +public java.lang.Boolean|IResolvable getReviewDraftPullRequests(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `reviewOnPush`Required + +```java +public java.lang.Boolean|IResolvable getReviewOnPush(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `internalValue`Optional + +```java +public RepositoryRulesetRulesCopilotCodeReview getInternalValue(); +``` + +- *Type:* RepositoryRulesetRulesCopilotCodeReview + +--- + + +### RepositoryRulesetRulesFileExtensionRestrictionOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesFileExtensionRestrictionOutputReference; + +new RepositoryRulesetRulesFileExtensionRestrictionOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| restrictedFileExtensionsInput | java.util.List | *No description.* | +| restrictedFileExtensions | java.util.List | *No description.* | +| internalValue | RepositoryRulesetRulesFileExtensionRestriction | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `restrictedFileExtensionsInput`Optional + +```java +public java.util.List getRestrictedFileExtensionsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `restrictedFileExtensions`Required + +```java +public java.util.List getRestrictedFileExtensions(); +``` + +- *Type:* java.util.List + +--- + +##### `internalValue`Optional + +```java +public RepositoryRulesetRulesFileExtensionRestriction getInternalValue(); +``` + +- *Type:* RepositoryRulesetRulesFileExtensionRestriction + +--- + + +### RepositoryRulesetRulesFilePathRestrictionOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesFilePathRestrictionOutputReference; + +new RepositoryRulesetRulesFilePathRestrictionOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| restrictedFilePathsInput | java.util.List | *No description.* | +| restrictedFilePaths | java.util.List | *No description.* | +| internalValue | RepositoryRulesetRulesFilePathRestriction | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `restrictedFilePathsInput`Optional + +```java +public java.util.List getRestrictedFilePathsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `restrictedFilePaths`Required + +```java +public java.util.List getRestrictedFilePaths(); +``` + +- *Type:* java.util.List + +--- + +##### `internalValue`Optional + +```java +public RepositoryRulesetRulesFilePathRestriction getInternalValue(); +``` + +- *Type:* RepositoryRulesetRulesFilePathRestriction + +--- + + +### RepositoryRulesetRulesMaxFilePathLengthOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesMaxFilePathLengthOutputReference; + +new RepositoryRulesetRulesMaxFilePathLengthOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| maxFilePathLengthInput | java.lang.Number | *No description.* | +| maxFilePathLength | java.lang.Number | *No description.* | +| internalValue | RepositoryRulesetRulesMaxFilePathLength | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `maxFilePathLengthInput`Optional + +```java +public java.lang.Number getMaxFilePathLengthInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `maxFilePathLength`Required + +```java +public java.lang.Number getMaxFilePathLength(); +``` + +- *Type:* java.lang.Number + +--- + +##### `internalValue`Optional + +```java +public RepositoryRulesetRulesMaxFilePathLength getInternalValue(); +``` + +- *Type:* RepositoryRulesetRulesMaxFilePathLength + +--- + + +### RepositoryRulesetRulesMaxFileSizeOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesMaxFileSizeOutputReference; + +new RepositoryRulesetRulesMaxFileSizeOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| maxFileSizeInput | java.lang.Number | *No description.* | +| maxFileSize | java.lang.Number | *No description.* | +| internalValue | RepositoryRulesetRulesMaxFileSize | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `maxFileSizeInput`Optional + +```java +public java.lang.Number getMaxFileSizeInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `maxFileSize`Required + +```java +public java.lang.Number getMaxFileSize(); +``` + +- *Type:* java.lang.Number + +--- + +##### `internalValue`Optional + +```java +public RepositoryRulesetRulesMaxFileSize getInternalValue(); +``` + +- *Type:* RepositoryRulesetRulesMaxFileSize + +--- + + +### RepositoryRulesetRulesMergeQueueOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesMergeQueueOutputReference; + +new RepositoryRulesetRulesMergeQueueOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetCheckResponseTimeoutMinutes | *No description.* | +| resetGroupingStrategy | *No description.* | +| resetMaxEntriesToBuild | *No description.* | +| resetMaxEntriesToMerge | *No description.* | +| resetMergeMethod | *No description.* | +| resetMinEntriesToMerge | *No description.* | +| resetMinEntriesToMergeWaitMinutes | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetCheckResponseTimeoutMinutes` + +```java +public void resetCheckResponseTimeoutMinutes() +``` + +##### `resetGroupingStrategy` + +```java +public void resetGroupingStrategy() +``` + +##### `resetMaxEntriesToBuild` + +```java +public void resetMaxEntriesToBuild() +``` + +##### `resetMaxEntriesToMerge` + +```java +public void resetMaxEntriesToMerge() +``` + +##### `resetMergeMethod` + +```java +public void resetMergeMethod() +``` + +##### `resetMinEntriesToMerge` + +```java +public void resetMinEntriesToMerge() +``` + +##### `resetMinEntriesToMergeWaitMinutes` + +```java +public void resetMinEntriesToMergeWaitMinutes() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| checkResponseTimeoutMinutesInput | java.lang.Number | *No description.* | +| groupingStrategyInput | java.lang.String | *No description.* | +| maxEntriesToBuildInput | java.lang.Number | *No description.* | +| maxEntriesToMergeInput | java.lang.Number | *No description.* | +| mergeMethodInput | java.lang.String | *No description.* | +| minEntriesToMergeInput | java.lang.Number | *No description.* | +| minEntriesToMergeWaitMinutesInput | java.lang.Number | *No description.* | +| checkResponseTimeoutMinutes | java.lang.Number | *No description.* | +| groupingStrategy | java.lang.String | *No description.* | +| maxEntriesToBuild | java.lang.Number | *No description.* | +| maxEntriesToMerge | java.lang.Number | *No description.* | +| mergeMethod | java.lang.String | *No description.* | +| minEntriesToMerge | java.lang.Number | *No description.* | +| minEntriesToMergeWaitMinutes | java.lang.Number | *No description.* | +| internalValue | RepositoryRulesetRulesMergeQueue | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `checkResponseTimeoutMinutesInput`Optional + +```java +public java.lang.Number getCheckResponseTimeoutMinutesInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `groupingStrategyInput`Optional + +```java +public java.lang.String getGroupingStrategyInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `maxEntriesToBuildInput`Optional + +```java +public java.lang.Number getMaxEntriesToBuildInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `maxEntriesToMergeInput`Optional + +```java +public java.lang.Number getMaxEntriesToMergeInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `mergeMethodInput`Optional + +```java +public java.lang.String getMergeMethodInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `minEntriesToMergeInput`Optional + +```java +public java.lang.Number getMinEntriesToMergeInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `minEntriesToMergeWaitMinutesInput`Optional + +```java +public java.lang.Number getMinEntriesToMergeWaitMinutesInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `checkResponseTimeoutMinutes`Required + +```java +public java.lang.Number getCheckResponseTimeoutMinutes(); +``` + +- *Type:* java.lang.Number + +--- + +##### `groupingStrategy`Required + +```java +public java.lang.String getGroupingStrategy(); +``` + +- *Type:* java.lang.String + +--- + +##### `maxEntriesToBuild`Required + +```java +public java.lang.Number getMaxEntriesToBuild(); +``` + +- *Type:* java.lang.Number + +--- + +##### `maxEntriesToMerge`Required + +```java +public java.lang.Number getMaxEntriesToMerge(); +``` + +- *Type:* java.lang.Number + +--- + +##### `mergeMethod`Required + +```java +public java.lang.String getMergeMethod(); +``` + +- *Type:* java.lang.String + +--- + +##### `minEntriesToMerge`Required + +```java +public java.lang.Number getMinEntriesToMerge(); +``` + +- *Type:* java.lang.Number + +--- + +##### `minEntriesToMergeWaitMinutes`Required + +```java +public java.lang.Number getMinEntriesToMergeWaitMinutes(); +``` + +- *Type:* java.lang.Number + +--- + +##### `internalValue`Optional + +```java +public RepositoryRulesetRulesMergeQueue getInternalValue(); +``` + +- *Type:* RepositoryRulesetRulesMergeQueue + +--- + + +### RepositoryRulesetRulesOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesOutputReference; + +new RepositoryRulesetRulesOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| putBranchNamePattern | *No description.* | +| putCommitAuthorEmailPattern | *No description.* | +| putCommitMessagePattern | *No description.* | +| putCommitterEmailPattern | *No description.* | +| putCopilotCodeReview | *No description.* | +| putFileExtensionRestriction | *No description.* | +| putFilePathRestriction | *No description.* | +| putMaxFilePathLength | *No description.* | +| putMaxFileSize | *No description.* | +| putMergeQueue | *No description.* | +| putPullRequest | *No description.* | +| putRequiredCodeScanning | *No description.* | +| putRequiredDeployments | *No description.* | +| putRequiredStatusChecks | *No description.* | +| putTagNamePattern | *No description.* | +| resetBranchNamePattern | *No description.* | +| resetCommitAuthorEmailPattern | *No description.* | +| resetCommitMessagePattern | *No description.* | +| resetCommitterEmailPattern | *No description.* | +| resetCopilotCodeReview | *No description.* | +| resetCreation | *No description.* | +| resetDeletion | *No description.* | +| resetFileExtensionRestriction | *No description.* | +| resetFilePathRestriction | *No description.* | +| resetMaxFilePathLength | *No description.* | +| resetMaxFileSize | *No description.* | +| resetMergeQueue | *No description.* | +| resetNonFastForward | *No description.* | +| resetPullRequest | *No description.* | +| resetRequiredCodeScanning | *No description.* | +| resetRequiredDeployments | *No description.* | +| resetRequiredLinearHistory | *No description.* | +| resetRequiredSignatures | *No description.* | +| resetRequiredStatusChecks | *No description.* | +| resetTagNamePattern | *No description.* | +| resetUpdate | *No description.* | +| resetUpdateAllowsFetchAndMerge | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `putBranchNamePattern` + +```java +public void putBranchNamePattern(RepositoryRulesetRulesBranchNamePattern value) +``` + +###### `value`Required + +- *Type:* RepositoryRulesetRulesBranchNamePattern + +--- + +##### `putCommitAuthorEmailPattern` + +```java +public void putCommitAuthorEmailPattern(RepositoryRulesetRulesCommitAuthorEmailPattern value) +``` + +###### `value`Required + +- *Type:* RepositoryRulesetRulesCommitAuthorEmailPattern + +--- + +##### `putCommitMessagePattern` + +```java +public void putCommitMessagePattern(RepositoryRulesetRulesCommitMessagePattern value) +``` + +###### `value`Required + +- *Type:* RepositoryRulesetRulesCommitMessagePattern + +--- + +##### `putCommitterEmailPattern` + +```java +public void putCommitterEmailPattern(RepositoryRulesetRulesCommitterEmailPattern value) +``` + +###### `value`Required + +- *Type:* RepositoryRulesetRulesCommitterEmailPattern + +--- + +##### `putCopilotCodeReview` + +```java +public void putCopilotCodeReview(RepositoryRulesetRulesCopilotCodeReview value) +``` + +###### `value`Required + +- *Type:* RepositoryRulesetRulesCopilotCodeReview + +--- + +##### `putFileExtensionRestriction` + +```java +public void putFileExtensionRestriction(RepositoryRulesetRulesFileExtensionRestriction value) +``` + +###### `value`Required + +- *Type:* RepositoryRulesetRulesFileExtensionRestriction + +--- + +##### `putFilePathRestriction` + +```java +public void putFilePathRestriction(RepositoryRulesetRulesFilePathRestriction value) +``` + +###### `value`Required + +- *Type:* RepositoryRulesetRulesFilePathRestriction + +--- + +##### `putMaxFilePathLength` + +```java +public void putMaxFilePathLength(RepositoryRulesetRulesMaxFilePathLength value) +``` + +###### `value`Required + +- *Type:* RepositoryRulesetRulesMaxFilePathLength + +--- + +##### `putMaxFileSize` + +```java +public void putMaxFileSize(RepositoryRulesetRulesMaxFileSize value) +``` + +###### `value`Required + +- *Type:* RepositoryRulesetRulesMaxFileSize + +--- + +##### `putMergeQueue` + +```java +public void putMergeQueue(RepositoryRulesetRulesMergeQueue value) +``` + +###### `value`Required + +- *Type:* RepositoryRulesetRulesMergeQueue + +--- + +##### `putPullRequest` + +```java +public void putPullRequest(RepositoryRulesetRulesPullRequest value) +``` + +###### `value`Required + +- *Type:* RepositoryRulesetRulesPullRequest + +--- + +##### `putRequiredCodeScanning` + +```java +public void putRequiredCodeScanning(RepositoryRulesetRulesRequiredCodeScanning value) +``` + +###### `value`Required + +- *Type:* RepositoryRulesetRulesRequiredCodeScanning + +--- + +##### `putRequiredDeployments` + +```java +public void putRequiredDeployments(RepositoryRulesetRulesRequiredDeployments value) +``` + +###### `value`Required + +- *Type:* RepositoryRulesetRulesRequiredDeployments + +--- + +##### `putRequiredStatusChecks` + +```java +public void putRequiredStatusChecks(RepositoryRulesetRulesRequiredStatusChecks value) +``` + +###### `value`Required + +- *Type:* RepositoryRulesetRulesRequiredStatusChecks + +--- + +##### `putTagNamePattern` + +```java +public void putTagNamePattern(RepositoryRulesetRulesTagNamePattern value) +``` + +###### `value`Required + +- *Type:* RepositoryRulesetRulesTagNamePattern + +--- + +##### `resetBranchNamePattern` + +```java +public void resetBranchNamePattern() +``` + +##### `resetCommitAuthorEmailPattern` + +```java +public void resetCommitAuthorEmailPattern() +``` + +##### `resetCommitMessagePattern` + +```java +public void resetCommitMessagePattern() +``` + +##### `resetCommitterEmailPattern` + +```java +public void resetCommitterEmailPattern() +``` + +##### `resetCopilotCodeReview` + +```java +public void resetCopilotCodeReview() +``` + +##### `resetCreation` + +```java +public void resetCreation() +``` + +##### `resetDeletion` + +```java +public void resetDeletion() +``` + +##### `resetFileExtensionRestriction` + +```java +public void resetFileExtensionRestriction() +``` + +##### `resetFilePathRestriction` + +```java +public void resetFilePathRestriction() +``` + +##### `resetMaxFilePathLength` + +```java +public void resetMaxFilePathLength() +``` + +##### `resetMaxFileSize` + +```java +public void resetMaxFileSize() +``` + +##### `resetMergeQueue` + +```java +public void resetMergeQueue() +``` + +##### `resetNonFastForward` + +```java +public void resetNonFastForward() +``` + +##### `resetPullRequest` + +```java +public void resetPullRequest() +``` + +##### `resetRequiredCodeScanning` + +```java +public void resetRequiredCodeScanning() +``` + +##### `resetRequiredDeployments` + +```java +public void resetRequiredDeployments() +``` + +##### `resetRequiredLinearHistory` + +```java +public void resetRequiredLinearHistory() +``` + +##### `resetRequiredSignatures` + +```java +public void resetRequiredSignatures() +``` + +##### `resetRequiredStatusChecks` + +```java +public void resetRequiredStatusChecks() +``` + +##### `resetTagNamePattern` + +```java +public void resetTagNamePattern() +``` + +##### `resetUpdate` + +```java +public void resetUpdate() +``` + +##### `resetUpdateAllowsFetchAndMerge` + +```java +public void resetUpdateAllowsFetchAndMerge() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| branchNamePattern | RepositoryRulesetRulesBranchNamePatternOutputReference | *No description.* | +| commitAuthorEmailPattern | RepositoryRulesetRulesCommitAuthorEmailPatternOutputReference | *No description.* | +| commitMessagePattern | RepositoryRulesetRulesCommitMessagePatternOutputReference | *No description.* | +| committerEmailPattern | RepositoryRulesetRulesCommitterEmailPatternOutputReference | *No description.* | +| copilotCodeReview | RepositoryRulesetRulesCopilotCodeReviewOutputReference | *No description.* | +| fileExtensionRestriction | RepositoryRulesetRulesFileExtensionRestrictionOutputReference | *No description.* | +| filePathRestriction | RepositoryRulesetRulesFilePathRestrictionOutputReference | *No description.* | +| maxFilePathLength | RepositoryRulesetRulesMaxFilePathLengthOutputReference | *No description.* | +| maxFileSize | RepositoryRulesetRulesMaxFileSizeOutputReference | *No description.* | +| mergeQueue | RepositoryRulesetRulesMergeQueueOutputReference | *No description.* | +| pullRequest | RepositoryRulesetRulesPullRequestOutputReference | *No description.* | +| requiredCodeScanning | RepositoryRulesetRulesRequiredCodeScanningOutputReference | *No description.* | +| requiredDeployments | RepositoryRulesetRulesRequiredDeploymentsOutputReference | *No description.* | +| requiredStatusChecks | RepositoryRulesetRulesRequiredStatusChecksOutputReference | *No description.* | +| tagNamePattern | RepositoryRulesetRulesTagNamePatternOutputReference | *No description.* | +| branchNamePatternInput | RepositoryRulesetRulesBranchNamePattern | *No description.* | +| commitAuthorEmailPatternInput | RepositoryRulesetRulesCommitAuthorEmailPattern | *No description.* | +| commitMessagePatternInput | RepositoryRulesetRulesCommitMessagePattern | *No description.* | +| committerEmailPatternInput | RepositoryRulesetRulesCommitterEmailPattern | *No description.* | +| copilotCodeReviewInput | RepositoryRulesetRulesCopilotCodeReview | *No description.* | +| creationInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| deletionInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| fileExtensionRestrictionInput | RepositoryRulesetRulesFileExtensionRestriction | *No description.* | +| filePathRestrictionInput | RepositoryRulesetRulesFilePathRestriction | *No description.* | +| maxFilePathLengthInput | RepositoryRulesetRulesMaxFilePathLength | *No description.* | +| maxFileSizeInput | RepositoryRulesetRulesMaxFileSize | *No description.* | +| mergeQueueInput | RepositoryRulesetRulesMergeQueue | *No description.* | +| nonFastForwardInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| pullRequestInput | RepositoryRulesetRulesPullRequest | *No description.* | +| requiredCodeScanningInput | RepositoryRulesetRulesRequiredCodeScanning | *No description.* | +| requiredDeploymentsInput | RepositoryRulesetRulesRequiredDeployments | *No description.* | +| requiredLinearHistoryInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requiredSignaturesInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requiredStatusChecksInput | RepositoryRulesetRulesRequiredStatusChecks | *No description.* | +| tagNamePatternInput | RepositoryRulesetRulesTagNamePattern | *No description.* | +| updateAllowsFetchAndMergeInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| updateInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| creation | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| deletion | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| nonFastForward | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requiredLinearHistory | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requiredSignatures | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| update | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| updateAllowsFetchAndMerge | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| internalValue | RepositoryRulesetRules | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `branchNamePattern`Required + +```java +public RepositoryRulesetRulesBranchNamePatternOutputReference getBranchNamePattern(); +``` + +- *Type:* RepositoryRulesetRulesBranchNamePatternOutputReference + +--- + +##### `commitAuthorEmailPattern`Required + +```java +public RepositoryRulesetRulesCommitAuthorEmailPatternOutputReference getCommitAuthorEmailPattern(); +``` + +- *Type:* RepositoryRulesetRulesCommitAuthorEmailPatternOutputReference + +--- + +##### `commitMessagePattern`Required + +```java +public RepositoryRulesetRulesCommitMessagePatternOutputReference getCommitMessagePattern(); +``` + +- *Type:* RepositoryRulesetRulesCommitMessagePatternOutputReference + +--- + +##### `committerEmailPattern`Required + +```java +public RepositoryRulesetRulesCommitterEmailPatternOutputReference getCommitterEmailPattern(); +``` + +- *Type:* RepositoryRulesetRulesCommitterEmailPatternOutputReference + +--- + +##### `copilotCodeReview`Required + +```java +public RepositoryRulesetRulesCopilotCodeReviewOutputReference getCopilotCodeReview(); +``` + +- *Type:* RepositoryRulesetRulesCopilotCodeReviewOutputReference + +--- + +##### `fileExtensionRestriction`Required + +```java +public RepositoryRulesetRulesFileExtensionRestrictionOutputReference getFileExtensionRestriction(); +``` + +- *Type:* RepositoryRulesetRulesFileExtensionRestrictionOutputReference + +--- + +##### `filePathRestriction`Required + +```java +public RepositoryRulesetRulesFilePathRestrictionOutputReference getFilePathRestriction(); +``` + +- *Type:* RepositoryRulesetRulesFilePathRestrictionOutputReference + +--- + +##### `maxFilePathLength`Required + +```java +public RepositoryRulesetRulesMaxFilePathLengthOutputReference getMaxFilePathLength(); +``` + +- *Type:* RepositoryRulesetRulesMaxFilePathLengthOutputReference + +--- + +##### `maxFileSize`Required + +```java +public RepositoryRulesetRulesMaxFileSizeOutputReference getMaxFileSize(); +``` + +- *Type:* RepositoryRulesetRulesMaxFileSizeOutputReference + +--- + +##### `mergeQueue`Required + +```java +public RepositoryRulesetRulesMergeQueueOutputReference getMergeQueue(); +``` + +- *Type:* RepositoryRulesetRulesMergeQueueOutputReference + +--- + +##### `pullRequest`Required + +```java +public RepositoryRulesetRulesPullRequestOutputReference getPullRequest(); +``` + +- *Type:* RepositoryRulesetRulesPullRequestOutputReference + +--- + +##### `requiredCodeScanning`Required + +```java +public RepositoryRulesetRulesRequiredCodeScanningOutputReference getRequiredCodeScanning(); +``` + +- *Type:* RepositoryRulesetRulesRequiredCodeScanningOutputReference + +--- + +##### `requiredDeployments`Required + +```java +public RepositoryRulesetRulesRequiredDeploymentsOutputReference getRequiredDeployments(); +``` + +- *Type:* RepositoryRulesetRulesRequiredDeploymentsOutputReference + +--- + +##### `requiredStatusChecks`Required + +```java +public RepositoryRulesetRulesRequiredStatusChecksOutputReference getRequiredStatusChecks(); +``` + +- *Type:* RepositoryRulesetRulesRequiredStatusChecksOutputReference + +--- + +##### `tagNamePattern`Required + +```java +public RepositoryRulesetRulesTagNamePatternOutputReference getTagNamePattern(); +``` + +- *Type:* RepositoryRulesetRulesTagNamePatternOutputReference + +--- + +##### `branchNamePatternInput`Optional + +```java +public RepositoryRulesetRulesBranchNamePattern getBranchNamePatternInput(); +``` + +- *Type:* RepositoryRulesetRulesBranchNamePattern + +--- + +##### `commitAuthorEmailPatternInput`Optional + +```java +public RepositoryRulesetRulesCommitAuthorEmailPattern getCommitAuthorEmailPatternInput(); +``` + +- *Type:* RepositoryRulesetRulesCommitAuthorEmailPattern + +--- + +##### `commitMessagePatternInput`Optional + +```java +public RepositoryRulesetRulesCommitMessagePattern getCommitMessagePatternInput(); +``` + +- *Type:* RepositoryRulesetRulesCommitMessagePattern + +--- + +##### `committerEmailPatternInput`Optional + +```java +public RepositoryRulesetRulesCommitterEmailPattern getCommitterEmailPatternInput(); +``` + +- *Type:* RepositoryRulesetRulesCommitterEmailPattern + +--- + +##### `copilotCodeReviewInput`Optional + +```java +public RepositoryRulesetRulesCopilotCodeReview getCopilotCodeReviewInput(); +``` + +- *Type:* RepositoryRulesetRulesCopilotCodeReview + +--- + +##### `creationInput`Optional + +```java +public java.lang.Boolean|IResolvable getCreationInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `deletionInput`Optional + +```java +public java.lang.Boolean|IResolvable getDeletionInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `fileExtensionRestrictionInput`Optional + +```java +public RepositoryRulesetRulesFileExtensionRestriction getFileExtensionRestrictionInput(); +``` + +- *Type:* RepositoryRulesetRulesFileExtensionRestriction + +--- + +##### `filePathRestrictionInput`Optional + +```java +public RepositoryRulesetRulesFilePathRestriction getFilePathRestrictionInput(); +``` + +- *Type:* RepositoryRulesetRulesFilePathRestriction + +--- + +##### `maxFilePathLengthInput`Optional + +```java +public RepositoryRulesetRulesMaxFilePathLength getMaxFilePathLengthInput(); +``` + +- *Type:* RepositoryRulesetRulesMaxFilePathLength + +--- + +##### `maxFileSizeInput`Optional + +```java +public RepositoryRulesetRulesMaxFileSize getMaxFileSizeInput(); +``` + +- *Type:* RepositoryRulesetRulesMaxFileSize + +--- + +##### `mergeQueueInput`Optional + +```java +public RepositoryRulesetRulesMergeQueue getMergeQueueInput(); +``` + +- *Type:* RepositoryRulesetRulesMergeQueue + +--- + +##### `nonFastForwardInput`Optional + +```java +public java.lang.Boolean|IResolvable getNonFastForwardInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `pullRequestInput`Optional + +```java +public RepositoryRulesetRulesPullRequest getPullRequestInput(); +``` + +- *Type:* RepositoryRulesetRulesPullRequest + +--- + +##### `requiredCodeScanningInput`Optional + +```java +public RepositoryRulesetRulesRequiredCodeScanning getRequiredCodeScanningInput(); +``` + +- *Type:* RepositoryRulesetRulesRequiredCodeScanning + +--- + +##### `requiredDeploymentsInput`Optional + +```java +public RepositoryRulesetRulesRequiredDeployments getRequiredDeploymentsInput(); +``` + +- *Type:* RepositoryRulesetRulesRequiredDeployments + +--- + +##### `requiredLinearHistoryInput`Optional + +```java +public java.lang.Boolean|IResolvable getRequiredLinearHistoryInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requiredSignaturesInput`Optional + +```java +public java.lang.Boolean|IResolvable getRequiredSignaturesInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requiredStatusChecksInput`Optional + +```java +public RepositoryRulesetRulesRequiredStatusChecks getRequiredStatusChecksInput(); +``` + +- *Type:* RepositoryRulesetRulesRequiredStatusChecks + +--- + +##### `tagNamePatternInput`Optional + +```java +public RepositoryRulesetRulesTagNamePattern getTagNamePatternInput(); +``` + +- *Type:* RepositoryRulesetRulesTagNamePattern + +--- + +##### `updateAllowsFetchAndMergeInput`Optional + +```java +public java.lang.Boolean|IResolvable getUpdateAllowsFetchAndMergeInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `updateInput`Optional + +```java +public java.lang.Boolean|IResolvable getUpdateInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `creation`Required + +```java +public java.lang.Boolean|IResolvable getCreation(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `deletion`Required + +```java +public java.lang.Boolean|IResolvable getDeletion(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `nonFastForward`Required + +```java +public java.lang.Boolean|IResolvable getNonFastForward(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requiredLinearHistory`Required + +```java +public java.lang.Boolean|IResolvable getRequiredLinearHistory(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requiredSignatures`Required + +```java +public java.lang.Boolean|IResolvable getRequiredSignatures(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `update`Required + +```java +public java.lang.Boolean|IResolvable getUpdate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `updateAllowsFetchAndMerge`Required + +```java +public java.lang.Boolean|IResolvable getUpdateAllowsFetchAndMerge(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `internalValue`Optional + +```java +public RepositoryRulesetRules getInternalValue(); +``` + +- *Type:* RepositoryRulesetRules + +--- + + +### RepositoryRulesetRulesPullRequestOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesPullRequestOutputReference; + +new RepositoryRulesetRulesPullRequestOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| putRequiredReviewers | *No description.* | +| resetAllowedMergeMethods | *No description.* | +| resetDismissStaleReviewsOnPush | *No description.* | +| resetRequireCodeOwnerReview | *No description.* | +| resetRequiredApprovingReviewCount | *No description.* | +| resetRequiredReviewers | *No description.* | +| resetRequiredReviewThreadResolution | *No description.* | +| resetRequireLastPushApproval | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `putRequiredReviewers` + +```java +public void putRequiredReviewers(IResolvable|java.util.List value) +``` + +###### `value`Required + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryRulesetRulesPullRequestRequiredReviewers> + +--- + +##### `resetAllowedMergeMethods` + +```java +public void resetAllowedMergeMethods() +``` + +##### `resetDismissStaleReviewsOnPush` + +```java +public void resetDismissStaleReviewsOnPush() +``` + +##### `resetRequireCodeOwnerReview` + +```java +public void resetRequireCodeOwnerReview() +``` + +##### `resetRequiredApprovingReviewCount` + +```java +public void resetRequiredApprovingReviewCount() +``` + +##### `resetRequiredReviewers` + +```java +public void resetRequiredReviewers() +``` + +##### `resetRequiredReviewThreadResolution` + +```java +public void resetRequiredReviewThreadResolution() +``` + +##### `resetRequireLastPushApproval` + +```java +public void resetRequireLastPushApproval() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| requiredReviewers | RepositoryRulesetRulesPullRequestRequiredReviewersList | *No description.* | +| allowedMergeMethodsInput | java.util.List | *No description.* | +| dismissStaleReviewsOnPushInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requireCodeOwnerReviewInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requiredApprovingReviewCountInput | java.lang.Number | *No description.* | +| requiredReviewersInput | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryRulesetRulesPullRequestRequiredReviewers> | *No description.* | +| requiredReviewThreadResolutionInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requireLastPushApprovalInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| allowedMergeMethods | java.util.List | *No description.* | +| dismissStaleReviewsOnPush | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requireCodeOwnerReview | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requiredApprovingReviewCount | java.lang.Number | *No description.* | +| requiredReviewThreadResolution | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requireLastPushApproval | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| internalValue | RepositoryRulesetRulesPullRequest | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `requiredReviewers`Required + +```java +public RepositoryRulesetRulesPullRequestRequiredReviewersList getRequiredReviewers(); +``` + +- *Type:* RepositoryRulesetRulesPullRequestRequiredReviewersList + +--- + +##### `allowedMergeMethodsInput`Optional + +```java +public java.util.List getAllowedMergeMethodsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `dismissStaleReviewsOnPushInput`Optional + +```java +public java.lang.Boolean|IResolvable getDismissStaleReviewsOnPushInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requireCodeOwnerReviewInput`Optional + +```java +public java.lang.Boolean|IResolvable getRequireCodeOwnerReviewInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requiredApprovingReviewCountInput`Optional + +```java +public java.lang.Number getRequiredApprovingReviewCountInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `requiredReviewersInput`Optional + +```java +public IResolvable|java.util.List getRequiredReviewersInput(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryRulesetRulesPullRequestRequiredReviewers> + +--- + +##### `requiredReviewThreadResolutionInput`Optional + +```java +public java.lang.Boolean|IResolvable getRequiredReviewThreadResolutionInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requireLastPushApprovalInput`Optional + +```java +public java.lang.Boolean|IResolvable getRequireLastPushApprovalInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `allowedMergeMethods`Required + +```java +public java.util.List getAllowedMergeMethods(); +``` + +- *Type:* java.util.List + +--- + +##### `dismissStaleReviewsOnPush`Required + +```java +public java.lang.Boolean|IResolvable getDismissStaleReviewsOnPush(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requireCodeOwnerReview`Required + +```java +public java.lang.Boolean|IResolvable getRequireCodeOwnerReview(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requiredApprovingReviewCount`Required + +```java +public java.lang.Number getRequiredApprovingReviewCount(); +``` + +- *Type:* java.lang.Number + +--- + +##### `requiredReviewThreadResolution`Required + +```java +public java.lang.Boolean|IResolvable getRequiredReviewThreadResolution(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requireLastPushApproval`Required + +```java +public java.lang.Boolean|IResolvable getRequireLastPushApproval(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `internalValue`Optional + +```java +public RepositoryRulesetRulesPullRequest getInternalValue(); +``` + +- *Type:* RepositoryRulesetRulesPullRequest + +--- + + +### RepositoryRulesetRulesPullRequestRequiredReviewersList + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesPullRequestRequiredReviewersList; + +new RepositoryRulesetRulesPullRequestRequiredReviewersList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public RepositoryRulesetRulesPullRequestRequiredReviewersOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryRulesetRulesPullRequestRequiredReviewers> | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|java.util.List getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryRulesetRulesPullRequestRequiredReviewers> + +--- + + +### RepositoryRulesetRulesPullRequestRequiredReviewersOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesPullRequestRequiredReviewersOutputReference; + +new RepositoryRulesetRulesPullRequestRequiredReviewersOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| putReviewer | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `putReviewer` + +```java +public void putReviewer(RepositoryRulesetRulesPullRequestRequiredReviewersReviewer value) +``` + +###### `value`Required + +- *Type:* RepositoryRulesetRulesPullRequestRequiredReviewersReviewer + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| reviewer | RepositoryRulesetRulesPullRequestRequiredReviewersReviewerOutputReference | *No description.* | +| filePatternsInput | java.util.List | *No description.* | +| minimumApprovalsInput | java.lang.Number | *No description.* | +| reviewerInput | RepositoryRulesetRulesPullRequestRequiredReviewersReviewer | *No description.* | +| filePatterns | java.util.List | *No description.* | +| minimumApprovals | java.lang.Number | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|RepositoryRulesetRulesPullRequestRequiredReviewers | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `reviewer`Required + +```java +public RepositoryRulesetRulesPullRequestRequiredReviewersReviewerOutputReference getReviewer(); +``` + +- *Type:* RepositoryRulesetRulesPullRequestRequiredReviewersReviewerOutputReference + +--- + +##### `filePatternsInput`Optional + +```java +public java.util.List getFilePatternsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `minimumApprovalsInput`Optional + +```java +public java.lang.Number getMinimumApprovalsInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `reviewerInput`Optional + +```java +public RepositoryRulesetRulesPullRequestRequiredReviewersReviewer getReviewerInput(); +``` + +- *Type:* RepositoryRulesetRulesPullRequestRequiredReviewersReviewer + +--- + +##### `filePatterns`Required + +```java +public java.util.List getFilePatterns(); +``` + +- *Type:* java.util.List + +--- + +##### `minimumApprovals`Required + +```java +public java.lang.Number getMinimumApprovals(); +``` + +- *Type:* java.lang.Number + +--- + +##### `internalValue`Optional + +```java +public IResolvable|RepositoryRulesetRulesPullRequestRequiredReviewers getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|RepositoryRulesetRulesPullRequestRequiredReviewers + +--- + + +### RepositoryRulesetRulesPullRequestRequiredReviewersReviewerOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesPullRequestRequiredReviewersReviewerOutputReference; + +new RepositoryRulesetRulesPullRequestRequiredReviewersReviewerOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| idInput | java.lang.Number | *No description.* | +| typeInput | java.lang.String | *No description.* | +| id | java.lang.Number | *No description.* | +| type | java.lang.String | *No description.* | +| internalValue | RepositoryRulesetRulesPullRequestRequiredReviewersReviewer | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.Number getIdInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `typeInput`Optional + +```java +public java.lang.String getTypeInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.Number getId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `type`Required + +```java +public java.lang.String getType(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public RepositoryRulesetRulesPullRequestRequiredReviewersReviewer getInternalValue(); +``` + +- *Type:* RepositoryRulesetRulesPullRequestRequiredReviewersReviewer + +--- + + +### RepositoryRulesetRulesRequiredCodeScanningOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesRequiredCodeScanningOutputReference; + +new RepositoryRulesetRulesRequiredCodeScanningOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| putRequiredCodeScanningTool | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `putRequiredCodeScanningTool` + +```java +public void putRequiredCodeScanningTool(IResolvable|java.util.List value) +``` + +###### `value`Required + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool> + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| requiredCodeScanningTool | RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningToolList | *No description.* | +| requiredCodeScanningToolInput | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool> | *No description.* | +| internalValue | RepositoryRulesetRulesRequiredCodeScanning | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `requiredCodeScanningTool`Required + +```java +public RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningToolList getRequiredCodeScanningTool(); +``` + +- *Type:* RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningToolList + +--- + +##### `requiredCodeScanningToolInput`Optional + +```java +public IResolvable|java.util.List getRequiredCodeScanningToolInput(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool> + +--- + +##### `internalValue`Optional + +```java +public RepositoryRulesetRulesRequiredCodeScanning getInternalValue(); +``` + +- *Type:* RepositoryRulesetRulesRequiredCodeScanning + +--- + + +### RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningToolList + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningToolList; + +new RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningToolList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningToolOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool> | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|java.util.List getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool> + +--- + + +### RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningToolOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningToolOutputReference; + +new RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningToolOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| alertsThresholdInput | java.lang.String | *No description.* | +| securityAlertsThresholdInput | java.lang.String | *No description.* | +| toolInput | java.lang.String | *No description.* | +| alertsThreshold | java.lang.String | *No description.* | +| securityAlertsThreshold | java.lang.String | *No description.* | +| tool | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `alertsThresholdInput`Optional + +```java +public java.lang.String getAlertsThresholdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `securityAlertsThresholdInput`Optional + +```java +public java.lang.String getSecurityAlertsThresholdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `toolInput`Optional + +```java +public java.lang.String getToolInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `alertsThreshold`Required + +```java +public java.lang.String getAlertsThreshold(); +``` + +- *Type:* java.lang.String + +--- + +##### `securityAlertsThreshold`Required + +```java +public java.lang.String getSecurityAlertsThreshold(); +``` + +- *Type:* java.lang.String + +--- + +##### `tool`Required + +```java +public java.lang.String getTool(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|RepositoryRulesetRulesRequiredCodeScanningRequiredCodeScanningTool + +--- + + +### RepositoryRulesetRulesRequiredDeploymentsOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesRequiredDeploymentsOutputReference; + +new RepositoryRulesetRulesRequiredDeploymentsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| requiredDeploymentEnvironmentsInput | java.util.List | *No description.* | +| requiredDeploymentEnvironments | java.util.List | *No description.* | +| internalValue | RepositoryRulesetRulesRequiredDeployments | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `requiredDeploymentEnvironmentsInput`Optional + +```java +public java.util.List getRequiredDeploymentEnvironmentsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `requiredDeploymentEnvironments`Required + +```java +public java.util.List getRequiredDeploymentEnvironments(); +``` + +- *Type:* java.util.List + +--- + +##### `internalValue`Optional + +```java +public RepositoryRulesetRulesRequiredDeployments getInternalValue(); +``` + +- *Type:* RepositoryRulesetRulesRequiredDeployments + +--- + + +### RepositoryRulesetRulesRequiredStatusChecksOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesRequiredStatusChecksOutputReference; + +new RepositoryRulesetRulesRequiredStatusChecksOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| putRequiredCheck | *No description.* | +| resetDoNotEnforceOnCreate | *No description.* | +| resetStrictRequiredStatusChecksPolicy | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `putRequiredCheck` + +```java +public void putRequiredCheck(IResolvable|java.util.List value) +``` + +###### `value`Required + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryRulesetRulesRequiredStatusChecksRequiredCheck> + +--- + +##### `resetDoNotEnforceOnCreate` + +```java +public void resetDoNotEnforceOnCreate() +``` + +##### `resetStrictRequiredStatusChecksPolicy` + +```java +public void resetStrictRequiredStatusChecksPolicy() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| requiredCheck | RepositoryRulesetRulesRequiredStatusChecksRequiredCheckList | *No description.* | +| doNotEnforceOnCreateInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| requiredCheckInput | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryRulesetRulesRequiredStatusChecksRequiredCheck> | *No description.* | +| strictRequiredStatusChecksPolicyInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| doNotEnforceOnCreate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| strictRequiredStatusChecksPolicy | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| internalValue | RepositoryRulesetRulesRequiredStatusChecks | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `requiredCheck`Required + +```java +public RepositoryRulesetRulesRequiredStatusChecksRequiredCheckList getRequiredCheck(); +``` + +- *Type:* RepositoryRulesetRulesRequiredStatusChecksRequiredCheckList + +--- + +##### `doNotEnforceOnCreateInput`Optional + +```java +public java.lang.Boolean|IResolvable getDoNotEnforceOnCreateInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `requiredCheckInput`Optional + +```java +public IResolvable|java.util.List getRequiredCheckInput(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryRulesetRulesRequiredStatusChecksRequiredCheck> + +--- + +##### `strictRequiredStatusChecksPolicyInput`Optional + +```java +public java.lang.Boolean|IResolvable getStrictRequiredStatusChecksPolicyInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `doNotEnforceOnCreate`Required + +```java +public java.lang.Boolean|IResolvable getDoNotEnforceOnCreate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `strictRequiredStatusChecksPolicy`Required + +```java +public java.lang.Boolean|IResolvable getStrictRequiredStatusChecksPolicy(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `internalValue`Optional + +```java +public RepositoryRulesetRulesRequiredStatusChecks getInternalValue(); +``` + +- *Type:* RepositoryRulesetRulesRequiredStatusChecks + +--- + + +### RepositoryRulesetRulesRequiredStatusChecksRequiredCheckList + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesRequiredStatusChecksRequiredCheckList; + +new RepositoryRulesetRulesRequiredStatusChecksRequiredCheckList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public RepositoryRulesetRulesRequiredStatusChecksRequiredCheckOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|java.util.List<RepositoryRulesetRulesRequiredStatusChecksRequiredCheck> | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|java.util.List getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<RepositoryRulesetRulesRequiredStatusChecksRequiredCheck> + +--- + + +### RepositoryRulesetRulesRequiredStatusChecksRequiredCheckOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesRequiredStatusChecksRequiredCheckOutputReference; + +new RepositoryRulesetRulesRequiredStatusChecksRequiredCheckOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetIntegrationId | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetIntegrationId` + +```java +public void resetIntegrationId() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| contextInput | java.lang.String | *No description.* | +| integrationIdInput | java.lang.Number | *No description.* | +| context | java.lang.String | *No description.* | +| integrationId | java.lang.Number | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|RepositoryRulesetRulesRequiredStatusChecksRequiredCheck | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `contextInput`Optional + +```java +public java.lang.String getContextInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `integrationIdInput`Optional + +```java +public java.lang.Number getIntegrationIdInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `context`Required + +```java +public java.lang.String getContext(); +``` + +- *Type:* java.lang.String + +--- + +##### `integrationId`Required + +```java +public java.lang.Number getIntegrationId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `internalValue`Optional + +```java +public IResolvable|RepositoryRulesetRulesRequiredStatusChecksRequiredCheck getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|RepositoryRulesetRulesRequiredStatusChecksRequiredCheck + +--- + + +### RepositoryRulesetRulesTagNamePatternOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_ruleset.RepositoryRulesetRulesTagNamePatternOutputReference; + +new RepositoryRulesetRulesTagNamePatternOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetName | *No description.* | +| resetNegate | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetName` + +```java +public void resetName() +``` + +##### `resetNegate` + +```java +public void resetNegate() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| negateInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| operatorInput | java.lang.String | *No description.* | +| patternInput | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| negate | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| operator | java.lang.String | *No description.* | +| pattern | java.lang.String | *No description.* | +| internalValue | RepositoryRulesetRulesTagNamePattern | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `negateInput`Optional + +```java +public java.lang.Boolean|IResolvable getNegateInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `operatorInput`Optional + +```java +public java.lang.String getOperatorInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `patternInput`Optional + +```java +public java.lang.String getPatternInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `negate`Required + +```java +public java.lang.Boolean|IResolvable getNegate(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `operator`Required + +```java +public java.lang.String getOperator(); +``` + +- *Type:* java.lang.String + +--- + +##### `pattern`Required + +```java +public java.lang.String getPattern(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public RepositoryRulesetRulesTagNamePattern getInternalValue(); +``` + +- *Type:* RepositoryRulesetRulesTagNamePattern + +--- + + + diff --git a/docs/repositoryTopics.csharp.md b/docs/repositoryTopics.csharp.md new file mode 100644 index 000000000..aaeb5ea4d --- /dev/null +++ b/docs/repositoryTopics.csharp.md @@ -0,0 +1,914 @@ +# `repositoryTopics` Submodule + +## Constructs + +### RepositoryTopics + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_topics github_repository_topics}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryTopics(Construct Scope, string Id, RepositoryTopicsConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | RepositoryTopicsConfig | *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:* RepositoryTopicsConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a RepositoryTopics resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryTopics.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` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryTopics.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryTopics.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryTopics.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a RepositoryTopics resource upon running "cdktn 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 RepositoryTopics to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing RepositoryTopics that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_topics#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the RepositoryTopics to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| TopicsInput | string[] | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | +| Topics | string[] | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `TopicsInput`Optional + +```csharp +public string[] TopicsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `Topics`Required + +```csharp +public string[] Topics { get; } +``` + +- *Type:* string[] + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### RepositoryTopicsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryTopicsConfig { + 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 Repository, + string[] Topics, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | The name of the repository. The name is not case sensitive. | +| Topics | string[] | An array of topics to add to the repository. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_topics#id RepositoryTopics#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The name of the repository. The name is not case sensitive. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_topics#repository RepositoryTopics#repository} + +--- + +##### `Topics`Required + +```csharp +public string[] Topics { get; set; } +``` + +- *Type:* string[] + +An array of topics to add to the repository. + +Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_topics#topics RepositoryTopics#topics} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_topics#id RepositoryTopics#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. + +--- + + + diff --git a/docs/repositoryTopics.java.md b/docs/repositoryTopics.java.md new file mode 100644 index 000000000..2eaf29efc --- /dev/null +++ b/docs/repositoryTopics.java.md @@ -0,0 +1,1005 @@ +# `repositoryTopics` Submodule + +## Constructs + +### RepositoryTopics + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_topics github_repository_topics}. + +#### Initializers + +```java +import io.cdktn.providers.github.repository_topics.RepositoryTopics; + +RepositoryTopics.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) + .topics(java.util.List) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | The name of the repository. The name is not case sensitive. | +| topics | java.util.List | An array of topics to add to the repository. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_topics#id RepositoryTopics#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The name of the repository. The name is not case sensitive. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_topics#repository RepositoryTopics#repository} + +--- + +##### `topics`Required + +- *Type:* java.util.List + +An array of topics to add to the repository. + +Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_topics#topics RepositoryTopics#topics} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_topics#id RepositoryTopics#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a RepositoryTopics resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.repository_topics.RepositoryTopics; + +RepositoryTopics.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` + +```java +import io.cdktn.providers.github.repository_topics.RepositoryTopics; + +RepositoryTopics.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.repository_topics.RepositoryTopics; + +RepositoryTopics.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.repository_topics.RepositoryTopics; + +RepositoryTopics.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),RepositoryTopics.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a RepositoryTopics 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 RepositoryTopics to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing RepositoryTopics that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_topics#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 RepositoryTopics 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| topicsInput | java.util.List | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | +| topics | java.util.List | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `topicsInput`Optional + +```java +public java.util.List getTopicsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `topics`Required + +```java +public java.util.List getTopics(); +``` + +- *Type:* java.util.List + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### RepositoryTopicsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.repository_topics.RepositoryTopicsConfig; + +RepositoryTopicsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) + .topics(java.util.List) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | The name of the repository. The name is not case sensitive. | +| topics | java.util.List | An array of topics to add to the repository. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_topics#id RepositoryTopics#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The name of the repository. The name is not case sensitive. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_topics#repository RepositoryTopics#repository} + +--- + +##### `topics`Required + +```java +public java.util.List getTopics(); +``` + +- *Type:* java.util.List + +An array of topics to add to the repository. + +Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_topics#topics RepositoryTopics#topics} + +--- + +##### `id`Optional + +```java +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/resources/repository_topics#id RepositoryTopics#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. + +--- + + + diff --git a/docs/repositoryVulnerabilityAlerts.csharp.md b/docs/repositoryVulnerabilityAlerts.csharp.md new file mode 100644 index 000000000..89f3a849a --- /dev/null +++ b/docs/repositoryVulnerabilityAlerts.csharp.md @@ -0,0 +1,930 @@ +# `repositoryVulnerabilityAlerts` Submodule + +## Constructs + +### RepositoryVulnerabilityAlerts + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_vulnerability_alerts github_repository_vulnerability_alerts}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryVulnerabilityAlerts(Construct Scope, string Id, RepositoryVulnerabilityAlertsConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | RepositoryVulnerabilityAlertsConfig | *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:* RepositoryVulnerabilityAlertsConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetEnabled | *No description.* | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetEnabled` + +```csharp +private void ResetEnabled() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a RepositoryVulnerabilityAlerts resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryVulnerabilityAlerts.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` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryVulnerabilityAlerts.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryVulnerabilityAlerts.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryVulnerabilityAlerts.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a RepositoryVulnerabilityAlerts resource upon running "cdktn 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 RepositoryVulnerabilityAlerts to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing RepositoryVulnerabilityAlerts that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_vulnerability_alerts#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the RepositoryVulnerabilityAlerts to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| RepositoryId | double | *No description.* | +| EnabledInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Enabled | bool\|Io.Cdktn.IResolvable | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `RepositoryId`Required + +```csharp +public double RepositoryId { get; } +``` + +- *Type:* double + +--- + +##### `EnabledInput`Optional + +```csharp +public bool|IResolvable EnabledInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Enabled`Required + +```csharp +public bool|IResolvable Enabled { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### RepositoryVulnerabilityAlertsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryVulnerabilityAlertsConfig { + 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 Repository, + bool|IResolvable Enabled = null, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | The repository name to configure vulnerability alerts for. | +| Enabled | bool\|Io.Cdktn.IResolvable | Whether vulnerability alerts are enabled for the repository. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_vulnerability_alerts#id RepositoryVulnerabilityAlerts#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The repository name to configure vulnerability alerts for. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_vulnerability_alerts#repository RepositoryVulnerabilityAlerts#repository} + +--- + +##### `Enabled`Optional + +```csharp +public bool|IResolvable Enabled { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether vulnerability alerts are enabled for the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_vulnerability_alerts#enabled RepositoryVulnerabilityAlerts#enabled} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_vulnerability_alerts#id RepositoryVulnerabilityAlerts#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. + +--- + + + diff --git a/docs/repositoryVulnerabilityAlerts.java.md b/docs/repositoryVulnerabilityAlerts.java.md new file mode 100644 index 000000000..0eee82068 --- /dev/null +++ b/docs/repositoryVulnerabilityAlerts.java.md @@ -0,0 +1,1019 @@ +# `repositoryVulnerabilityAlerts` Submodule + +## Constructs + +### RepositoryVulnerabilityAlerts + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_vulnerability_alerts github_repository_vulnerability_alerts}. + +#### Initializers + +```java +import io.cdktn.providers.github.repository_vulnerability_alerts.RepositoryVulnerabilityAlerts; + +RepositoryVulnerabilityAlerts.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .enabled(java.lang.Boolean|IResolvable) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | The repository name to configure vulnerability alerts for. | +| enabled | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether vulnerability alerts are enabled for the repository. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_vulnerability_alerts#id RepositoryVulnerabilityAlerts#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The repository name to configure vulnerability alerts for. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_vulnerability_alerts#repository RepositoryVulnerabilityAlerts#repository} + +--- + +##### `enabled`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether vulnerability alerts are enabled for the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_vulnerability_alerts#enabled RepositoryVulnerabilityAlerts#enabled} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_vulnerability_alerts#id RepositoryVulnerabilityAlerts#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetEnabled | *No description.* | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetEnabled` + +```java +public void resetEnabled() +``` + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a RepositoryVulnerabilityAlerts resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.repository_vulnerability_alerts.RepositoryVulnerabilityAlerts; + +RepositoryVulnerabilityAlerts.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` + +```java +import io.cdktn.providers.github.repository_vulnerability_alerts.RepositoryVulnerabilityAlerts; + +RepositoryVulnerabilityAlerts.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.repository_vulnerability_alerts.RepositoryVulnerabilityAlerts; + +RepositoryVulnerabilityAlerts.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.repository_vulnerability_alerts.RepositoryVulnerabilityAlerts; + +RepositoryVulnerabilityAlerts.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),RepositoryVulnerabilityAlerts.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a RepositoryVulnerabilityAlerts 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 RepositoryVulnerabilityAlerts to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing RepositoryVulnerabilityAlerts that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_vulnerability_alerts#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 RepositoryVulnerabilityAlerts 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| repositoryId | java.lang.Number | *No description.* | +| enabledInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| enabled | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repositoryId`Required + +```java +public java.lang.Number getRepositoryId(); +``` + +- *Type:* java.lang.Number + +--- + +##### `enabledInput`Optional + +```java +public java.lang.Boolean|IResolvable getEnabledInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `enabled`Required + +```java +public java.lang.Boolean|IResolvable getEnabled(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### RepositoryVulnerabilityAlertsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.repository_vulnerability_alerts.RepositoryVulnerabilityAlertsConfig; + +RepositoryVulnerabilityAlertsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .enabled(java.lang.Boolean|IResolvable) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | The repository name to configure vulnerability alerts for. | +| enabled | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether vulnerability alerts are enabled for the repository. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_vulnerability_alerts#id RepositoryVulnerabilityAlerts#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The repository name to configure vulnerability alerts for. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_vulnerability_alerts#repository RepositoryVulnerabilityAlerts#repository} + +--- + +##### `enabled`Optional + +```java +public java.lang.Boolean|IResolvable getEnabled(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether vulnerability alerts are enabled for the repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_vulnerability_alerts#enabled RepositoryVulnerabilityAlerts#enabled} + +--- + +##### `id`Optional + +```java +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/resources/repository_vulnerability_alerts#id RepositoryVulnerabilityAlerts#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. + +--- + + + diff --git a/docs/repositoryWebhook.csharp.md b/docs/repositoryWebhook.csharp.md new file mode 100644 index 000000000..6ae7f9218 --- /dev/null +++ b/docs/repositoryWebhook.csharp.md @@ -0,0 +1,1510 @@ +# `repositoryWebhook` Submodule + +## Constructs + +### RepositoryWebhook + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook github_repository_webhook}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryWebhook(Construct Scope, string Id, RepositoryWebhookConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | RepositoryWebhookConfig | *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:* RepositoryWebhookConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| PutConfiguration | *No description.* | +| ResetActive | *No description.* | +| ResetConfiguration | *No description.* | +| ResetEtag | *No description.* | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `PutConfiguration` + +```csharp +private void PutConfiguration(RepositoryWebhookConfiguration Value) +``` + +###### `Value`Required + +- *Type:* RepositoryWebhookConfiguration + +--- + +##### `ResetActive` + +```csharp +private void ResetActive() +``` + +##### `ResetConfiguration` + +```csharp +private void ResetConfiguration() +``` + +##### `ResetEtag` + +```csharp +private void ResetEtag() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a RepositoryWebhook resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryWebhook.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` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryWebhook.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryWebhook.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +RepositoryWebhook.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a RepositoryWebhook resource upon running "cdktn 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 RepositoryWebhook to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing RepositoryWebhook that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the RepositoryWebhook to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Configuration | RepositoryWebhookConfigurationOutputReference | *No description.* | +| Url | string | *No description.* | +| ActiveInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| ConfigurationInput | RepositoryWebhookConfiguration | *No description.* | +| EtagInput | string | *No description.* | +| EventsInput | string[] | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| Active | bool\|Io.Cdktn.IResolvable | *No description.* | +| Etag | string | *No description.* | +| Events | string[] | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Configuration`Required + +```csharp +public RepositoryWebhookConfigurationOutputReference Configuration { get; } +``` + +- *Type:* RepositoryWebhookConfigurationOutputReference + +--- + +##### `Url`Required + +```csharp +public string Url { get; } +``` + +- *Type:* string + +--- + +##### `ActiveInput`Optional + +```csharp +public bool|IResolvable ActiveInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ConfigurationInput`Optional + +```csharp +public RepositoryWebhookConfiguration ConfigurationInput { get; } +``` + +- *Type:* RepositoryWebhookConfiguration + +--- + +##### `EtagInput`Optional + +```csharp +public string EtagInput { get; } +``` + +- *Type:* string + +--- + +##### `EventsInput`Optional + +```csharp +public string[] EventsInput { get; } +``` + +- *Type:* string[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `Active`Required + +```csharp +public bool|IResolvable Active { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `Events`Required + +```csharp +public string[] Events { get; } +``` + +- *Type:* string[] + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### RepositoryWebhookConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryWebhookConfig { + 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[] Events, + string Repository, + bool|IResolvable Active = null, + RepositoryWebhookConfiguration Configuration = null, + string Etag = null, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Events | string[] | A list of events which should trigger the webhook. | +| Repository | string | The repository name of the webhook, not including the organization, which will be inferred. | +| Active | bool\|Io.Cdktn.IResolvable | Indicate if the webhook should receive events. Defaults to 'true'. | +| Configuration | RepositoryWebhookConfiguration | configuration block. | +| Etag | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#etag RepositoryWebhook#etag}. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#id RepositoryWebhook#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Events`Required + +```csharp +public string[] Events { get; set; } +``` + +- *Type:* string[] + +A list of events which should trigger the webhook. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#events RepositoryWebhook#events} + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The repository name of the webhook, not including the organization, which will be inferred. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#repository RepositoryWebhook#repository} + +--- + +##### `Active`Optional + +```csharp +public bool|IResolvable Active { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Indicate if the webhook should receive events. Defaults to 'true'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#active RepositoryWebhook#active} + +--- + +##### `Configuration`Optional + +```csharp +public RepositoryWebhookConfiguration Configuration { get; set; } +``` + +- *Type:* RepositoryWebhookConfiguration + +configuration block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#configuration RepositoryWebhook#configuration} + +--- + +##### `Etag`Optional + +```csharp +public string Etag { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#etag RepositoryWebhook#etag}. + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#id RepositoryWebhook#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. + +--- + +### RepositoryWebhookConfiguration + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryWebhookConfiguration { + string Url, + string ContentType = null, + bool|IResolvable InsecureSsl = null, + string Secret = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Url | string | The URL of the webhook. | +| ContentType | string | The content type for the payload. Valid values are either 'form' or 'json'. | +| InsecureSsl | bool\|Io.Cdktn.IResolvable | Insecure SSL boolean toggle. Defaults to 'false'. | +| Secret | string | The shared secret for the webhook. | + +--- + +##### `Url`Required + +```csharp +public string Url { get; set; } +``` + +- *Type:* string + +The URL of the webhook. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#url RepositoryWebhook#url} + +--- + +##### `ContentType`Optional + +```csharp +public string ContentType { get; set; } +``` + +- *Type:* string + +The content type for the payload. Valid values are either 'form' or 'json'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#content_type RepositoryWebhook#content_type} + +--- + +##### `InsecureSsl`Optional + +```csharp +public bool|IResolvable InsecureSsl { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Insecure SSL boolean toggle. Defaults to 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#insecure_ssl RepositoryWebhook#insecure_ssl} + +--- + +##### `Secret`Optional + +```csharp +public string Secret { get; set; } +``` + +- *Type:* string + +The shared secret for the webhook. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#secret RepositoryWebhook#secret} + +--- + +## Classes + +### RepositoryWebhookConfigurationOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new RepositoryWebhookConfigurationOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetContentType | *No description.* | +| ResetInsecureSsl | *No description.* | +| ResetSecret | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetContentType` + +```csharp +private void ResetContentType() +``` + +##### `ResetInsecureSsl` + +```csharp +private void ResetInsecureSsl() +``` + +##### `ResetSecret` + +```csharp +private void ResetSecret() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| ContentTypeInput | string | *No description.* | +| InsecureSslInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| SecretInput | string | *No description.* | +| UrlInput | string | *No description.* | +| ContentType | string | *No description.* | +| InsecureSsl | bool\|Io.Cdktn.IResolvable | *No description.* | +| Secret | string | *No description.* | +| Url | string | *No description.* | +| InternalValue | RepositoryWebhookConfiguration | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `ContentTypeInput`Optional + +```csharp +public string ContentTypeInput { get; } +``` + +- *Type:* string + +--- + +##### `InsecureSslInput`Optional + +```csharp +public bool|IResolvable InsecureSslInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `SecretInput`Optional + +```csharp +public string SecretInput { get; } +``` + +- *Type:* string + +--- + +##### `UrlInput`Optional + +```csharp +public string UrlInput { get; } +``` + +- *Type:* string + +--- + +##### `ContentType`Required + +```csharp +public string ContentType { get; } +``` + +- *Type:* string + +--- + +##### `InsecureSsl`Required + +```csharp +public bool|IResolvable InsecureSsl { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Secret`Required + +```csharp +public string Secret { get; } +``` + +- *Type:* string + +--- + +##### `Url`Required + +```csharp +public string Url { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public RepositoryWebhookConfiguration InternalValue { get; } +``` + +- *Type:* RepositoryWebhookConfiguration + +--- + + + diff --git a/docs/repositoryWebhook.java.md b/docs/repositoryWebhook.java.md new file mode 100644 index 000000000..0716e8082 --- /dev/null +++ b/docs/repositoryWebhook.java.md @@ -0,0 +1,1633 @@ +# `repositoryWebhook` Submodule + +## Constructs + +### RepositoryWebhook + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook github_repository_webhook}. + +#### Initializers + +```java +import io.cdktn.providers.github.repository_webhook.RepositoryWebhook; + +RepositoryWebhook.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .events(java.util.List) + .repository(java.lang.String) +// .active(java.lang.Boolean|IResolvable) +// .configuration(RepositoryWebhookConfiguration) +// .etag(java.lang.String) +// .id(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 | *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 | *No description.* | +| events | java.util.List | A list of events which should trigger the webhook. | +| repository | java.lang.String | The repository name of the webhook, not including the organization, which will be inferred. | +| active | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Indicate if the webhook should receive events. Defaults to 'true'. | +| configuration | RepositoryWebhookConfiguration | configuration block. | +| etag | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#etag RepositoryWebhook#etag}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#id RepositoryWebhook#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `events`Required + +- *Type:* java.util.List + +A list of events which should trigger the webhook. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#events RepositoryWebhook#events} + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The repository name of the webhook, not including the organization, which will be inferred. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#repository RepositoryWebhook#repository} + +--- + +##### `active`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Indicate if the webhook should receive events. Defaults to 'true'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#active RepositoryWebhook#active} + +--- + +##### `configuration`Optional + +- *Type:* RepositoryWebhookConfiguration + +configuration block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#configuration RepositoryWebhook#configuration} + +--- + +##### `etag`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#etag RepositoryWebhook#etag}. + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#id RepositoryWebhook#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| putConfiguration | *No description.* | +| resetActive | *No description.* | +| resetConfiguration | *No description.* | +| resetEtag | *No description.* | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `putConfiguration` + +```java +public void putConfiguration(RepositoryWebhookConfiguration value) +``` + +###### `value`Required + +- *Type:* RepositoryWebhookConfiguration + +--- + +##### `resetActive` + +```java +public void resetActive() +``` + +##### `resetConfiguration` + +```java +public void resetConfiguration() +``` + +##### `resetEtag` + +```java +public void resetEtag() +``` + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a RepositoryWebhook resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.repository_webhook.RepositoryWebhook; + +RepositoryWebhook.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` + +```java +import io.cdktn.providers.github.repository_webhook.RepositoryWebhook; + +RepositoryWebhook.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.repository_webhook.RepositoryWebhook; + +RepositoryWebhook.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.repository_webhook.RepositoryWebhook; + +RepositoryWebhook.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),RepositoryWebhook.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a RepositoryWebhook 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 RepositoryWebhook to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing RepositoryWebhook that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#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 RepositoryWebhook 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| configuration | RepositoryWebhookConfigurationOutputReference | *No description.* | +| url | java.lang.String | *No description.* | +| activeInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| configurationInput | RepositoryWebhookConfiguration | *No description.* | +| etagInput | java.lang.String | *No description.* | +| eventsInput | java.util.List | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| active | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| etag | java.lang.String | *No description.* | +| events | java.util.List | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `configuration`Required + +```java +public RepositoryWebhookConfigurationOutputReference getConfiguration(); +``` + +- *Type:* RepositoryWebhookConfigurationOutputReference + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `activeInput`Optional + +```java +public java.lang.Boolean|IResolvable getActiveInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `configurationInput`Optional + +```java +public RepositoryWebhookConfiguration getConfigurationInput(); +``` + +- *Type:* RepositoryWebhookConfiguration + +--- + +##### `etagInput`Optional + +```java +public java.lang.String getEtagInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `eventsInput`Optional + +```java +public java.util.List getEventsInput(); +``` + +- *Type:* java.util.List + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `active`Required + +```java +public java.lang.Boolean|IResolvable getActive(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `events`Required + +```java +public java.util.List getEvents(); +``` + +- *Type:* java.util.List + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### RepositoryWebhookConfig + +#### Initializer + +```java +import io.cdktn.providers.github.repository_webhook.RepositoryWebhookConfig; + +RepositoryWebhookConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .events(java.util.List) + .repository(java.lang.String) +// .active(java.lang.Boolean|IResolvable) +// .configuration(RepositoryWebhookConfiguration) +// .etag(java.lang.String) +// .id(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 | *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 | *No description.* | +| events | java.util.List | A list of events which should trigger the webhook. | +| repository | java.lang.String | The repository name of the webhook, not including the organization, which will be inferred. | +| active | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Indicate if the webhook should receive events. Defaults to 'true'. | +| configuration | RepositoryWebhookConfiguration | configuration block. | +| etag | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#etag RepositoryWebhook#etag}. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#id RepositoryWebhook#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `events`Required + +```java +public java.util.List getEvents(); +``` + +- *Type:* java.util.List + +A list of events which should trigger the webhook. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#events RepositoryWebhook#events} + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The repository name of the webhook, not including the organization, which will be inferred. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#repository RepositoryWebhook#repository} + +--- + +##### `active`Optional + +```java +public java.lang.Boolean|IResolvable getActive(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Indicate if the webhook should receive events. Defaults to 'true'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#active RepositoryWebhook#active} + +--- + +##### `configuration`Optional + +```java +public RepositoryWebhookConfiguration getConfiguration(); +``` + +- *Type:* RepositoryWebhookConfiguration + +configuration block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#configuration RepositoryWebhook#configuration} + +--- + +##### `etag`Optional + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#etag RepositoryWebhook#etag}. + +--- + +##### `id`Optional + +```java +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/resources/repository_webhook#id RepositoryWebhook#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. + +--- + +### RepositoryWebhookConfiguration + +#### Initializer + +```java +import io.cdktn.providers.github.repository_webhook.RepositoryWebhookConfiguration; + +RepositoryWebhookConfiguration.builder() + .url(java.lang.String) +// .contentType(java.lang.String) +// .insecureSsl(java.lang.Boolean|IResolvable) +// .secret(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| url | java.lang.String | The URL of the webhook. | +| contentType | java.lang.String | The content type for the payload. Valid values are either 'form' or 'json'. | +| insecureSsl | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Insecure SSL boolean toggle. Defaults to 'false'. | +| secret | java.lang.String | The shared secret for the webhook. | + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +The URL of the webhook. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#url RepositoryWebhook#url} + +--- + +##### `contentType`Optional + +```java +public java.lang.String getContentType(); +``` + +- *Type:* java.lang.String + +The content type for the payload. Valid values are either 'form' or 'json'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#content_type RepositoryWebhook#content_type} + +--- + +##### `insecureSsl`Optional + +```java +public java.lang.Boolean|IResolvable getInsecureSsl(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Insecure SSL boolean toggle. Defaults to 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#insecure_ssl RepositoryWebhook#insecure_ssl} + +--- + +##### `secret`Optional + +```java +public java.lang.String getSecret(); +``` + +- *Type:* java.lang.String + +The shared secret for the webhook. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/repository_webhook#secret RepositoryWebhook#secret} + +--- + +## Classes + +### RepositoryWebhookConfigurationOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.repository_webhook.RepositoryWebhookConfigurationOutputReference; + +new RepositoryWebhookConfigurationOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetContentType | *No description.* | +| resetInsecureSsl | *No description.* | +| resetSecret | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetContentType` + +```java +public void resetContentType() +``` + +##### `resetInsecureSsl` + +```java +public void resetInsecureSsl() +``` + +##### `resetSecret` + +```java +public void resetSecret() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| contentTypeInput | java.lang.String | *No description.* | +| insecureSslInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| secretInput | java.lang.String | *No description.* | +| urlInput | java.lang.String | *No description.* | +| contentType | java.lang.String | *No description.* | +| insecureSsl | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| secret | java.lang.String | *No description.* | +| url | java.lang.String | *No description.* | +| internalValue | RepositoryWebhookConfiguration | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `contentTypeInput`Optional + +```java +public java.lang.String getContentTypeInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `insecureSslInput`Optional + +```java +public java.lang.Boolean|IResolvable getInsecureSslInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `secretInput`Optional + +```java +public java.lang.String getSecretInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `urlInput`Optional + +```java +public java.lang.String getUrlInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `contentType`Required + +```java +public java.lang.String getContentType(); +``` + +- *Type:* java.lang.String + +--- + +##### `insecureSsl`Required + +```java +public java.lang.Boolean|IResolvable getInsecureSsl(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `secret`Required + +```java +public java.lang.String getSecret(); +``` + +- *Type:* java.lang.String + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public RepositoryWebhookConfiguration getInternalValue(); +``` + +- *Type:* RepositoryWebhookConfiguration + +--- + + + diff --git a/docs/team.csharp.md b/docs/team.csharp.md new file mode 100644 index 000000000..4b450a761 --- /dev/null +++ b/docs/team.csharp.md @@ -0,0 +1,1278 @@ +# `team` Submodule + +## Constructs + +### Team + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team github_team}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new Team(Construct Scope, string Id, TeamConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | TeamConfig | *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:* TeamConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetCreateDefaultMaintainer | *No description.* | +| ResetDescription | *No description.* | +| ResetId | *No description.* | +| ResetLdapDn | *No description.* | +| ResetNotificationSetting | *No description.* | +| ResetParentTeamId | *No description.* | +| ResetParentTeamReadId | *No description.* | +| ResetParentTeamReadSlug | *No description.* | +| ResetPrivacy | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetCreateDefaultMaintainer` + +```csharp +private void ResetCreateDefaultMaintainer() +``` + +##### `ResetDescription` + +```csharp +private void ResetDescription() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetLdapDn` + +```csharp +private void ResetLdapDn() +``` + +##### `ResetNotificationSetting` + +```csharp +private void ResetNotificationSetting() +``` + +##### `ResetParentTeamId` + +```csharp +private void ResetParentTeamId() +``` + +##### `ResetParentTeamReadId` + +```csharp +private void ResetParentTeamReadId() +``` + +##### `ResetParentTeamReadSlug` + +```csharp +private void ResetParentTeamReadSlug() +``` + +##### `ResetPrivacy` + +```csharp +private void ResetPrivacy() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a Team resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +Team.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` + +```csharp +using Io.Cdktn.Providers.Github; + +Team.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +Team.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +Team.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a Team resource upon running "cdktn 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 Team to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing Team that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the Team to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Etag | string | *No description.* | +| MembersCount | double | *No description.* | +| NodeId | string | *No description.* | +| Slug | string | *No description.* | +| CreateDefaultMaintainerInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| DescriptionInput | string | *No description.* | +| IdInput | string | *No description.* | +| LdapDnInput | string | *No description.* | +| NameInput | string | *No description.* | +| NotificationSettingInput | string | *No description.* | +| ParentTeamIdInput | string | *No description.* | +| ParentTeamReadIdInput | string | *No description.* | +| ParentTeamReadSlugInput | string | *No description.* | +| PrivacyInput | string | *No description.* | +| CreateDefaultMaintainer | bool\|Io.Cdktn.IResolvable | *No description.* | +| Description | string | *No description.* | +| Id | string | *No description.* | +| LdapDn | string | *No description.* | +| Name | string | *No description.* | +| NotificationSetting | string | *No description.* | +| ParentTeamId | string | *No description.* | +| ParentTeamReadId | string | *No description.* | +| ParentTeamReadSlug | string | *No description.* | +| Privacy | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `MembersCount`Required + +```csharp +public double MembersCount { get; } +``` + +- *Type:* double + +--- + +##### `NodeId`Required + +```csharp +public string NodeId { get; } +``` + +- *Type:* string + +--- + +##### `Slug`Required + +```csharp +public string Slug { get; } +``` + +- *Type:* string + +--- + +##### `CreateDefaultMaintainerInput`Optional + +```csharp +public bool|IResolvable CreateDefaultMaintainerInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `DescriptionInput`Optional + +```csharp +public string DescriptionInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `LdapDnInput`Optional + +```csharp +public string LdapDnInput { get; } +``` + +- *Type:* string + +--- + +##### `NameInput`Optional + +```csharp +public string NameInput { get; } +``` + +- *Type:* string + +--- + +##### `NotificationSettingInput`Optional + +```csharp +public string NotificationSettingInput { get; } +``` + +- *Type:* string + +--- + +##### `ParentTeamIdInput`Optional + +```csharp +public string ParentTeamIdInput { get; } +``` + +- *Type:* string + +--- + +##### `ParentTeamReadIdInput`Optional + +```csharp +public string ParentTeamReadIdInput { get; } +``` + +- *Type:* string + +--- + +##### `ParentTeamReadSlugInput`Optional + +```csharp +public string ParentTeamReadSlugInput { get; } +``` + +- *Type:* string + +--- + +##### `PrivacyInput`Optional + +```csharp +public string PrivacyInput { get; } +``` + +- *Type:* string + +--- + +##### `CreateDefaultMaintainer`Required + +```csharp +public bool|IResolvable CreateDefaultMaintainer { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Description`Required + +```csharp +public string Description { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `LdapDn`Required + +```csharp +public string LdapDn { get; } +``` + +- *Type:* string + +--- + +##### `Name`Required + +```csharp +public string Name { get; } +``` + +- *Type:* string + +--- + +##### `NotificationSetting`Required + +```csharp +public string NotificationSetting { get; } +``` + +- *Type:* string + +--- + +##### `ParentTeamId`Required + +```csharp +public string ParentTeamId { get; } +``` + +- *Type:* string + +--- + +##### `ParentTeamReadId`Required + +```csharp +public string ParentTeamReadId { get; } +``` + +- *Type:* string + +--- + +##### `ParentTeamReadSlug`Required + +```csharp +public string ParentTeamReadSlug { get; } +``` + +- *Type:* string + +--- + +##### `Privacy`Required + +```csharp +public string Privacy { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### TeamConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new TeamConfig { + 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 Name, + bool|IResolvable CreateDefaultMaintainer = null, + string Description = null, + string Id = null, + string LdapDn = null, + string NotificationSetting = null, + string ParentTeamId = null, + string ParentTeamReadId = null, + string ParentTeamReadSlug = null, + string Privacy = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Name | string | The name of the team. | +| CreateDefaultMaintainer | bool\|Io.Cdktn.IResolvable | Adds a default maintainer to the team. Adds the creating user to the team when 'true'. | +| Description | string | A description of the team. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#id Team#id}. | +| LdapDn | string | The LDAP Distinguished Name of the group where membership will be synchronized. Only available in GitHub Enterprise Server. | +| NotificationSetting | string | The notification setting for the team. Must be one of 'notifications_enabled' or 'notifications_disabled'. | +| ParentTeamId | string | The ID or slug of the parent team, if this is a nested team. | +| ParentTeamReadId | string | The id of the parent team read in Github. | +| ParentTeamReadSlug | string | The id of the parent team read in Github. | +| Privacy | string | The level of privacy for the team. Must be one of 'secret' or 'closed'. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Name`Required + +```csharp +public string Name { get; set; } +``` + +- *Type:* string + +The name of the team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#name Team#name} + +--- + +##### `CreateDefaultMaintainer`Optional + +```csharp +public bool|IResolvable CreateDefaultMaintainer { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Adds a default maintainer to the team. Adds the creating user to the team when 'true'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#create_default_maintainer Team#create_default_maintainer} + +--- + +##### `Description`Optional + +```csharp +public string Description { get; set; } +``` + +- *Type:* string + +A description of the team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#description Team#description} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#id Team#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. + +--- + +##### `LdapDn`Optional + +```csharp +public string LdapDn { get; set; } +``` + +- *Type:* string + +The LDAP Distinguished Name of the group where membership will be synchronized. Only available in GitHub Enterprise Server. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#ldap_dn Team#ldap_dn} + +--- + +##### `NotificationSetting`Optional + +```csharp +public string NotificationSetting { get; set; } +``` + +- *Type:* string + +The notification setting for the team. Must be one of 'notifications_enabled' or 'notifications_disabled'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#notification_setting Team#notification_setting} + +--- + +##### `ParentTeamId`Optional + +```csharp +public string ParentTeamId { get; set; } +``` + +- *Type:* string + +The ID or slug of the parent team, if this is a nested team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#parent_team_id Team#parent_team_id} + +--- + +##### `ParentTeamReadId`Optional + +```csharp +public string ParentTeamReadId { get; set; } +``` + +- *Type:* string + +The id of the parent team read in Github. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#parent_team_read_id Team#parent_team_read_id} + +--- + +##### `ParentTeamReadSlug`Optional + +```csharp +public string ParentTeamReadSlug { get; set; } +``` + +- *Type:* string + +The id of the parent team read in Github. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#parent_team_read_slug Team#parent_team_read_slug} + +--- + +##### `Privacy`Optional + +```csharp +public string Privacy { get; set; } +``` + +- *Type:* string + +The level of privacy for the team. Must be one of 'secret' or 'closed'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#privacy Team#privacy} + +--- + + + diff --git a/docs/team.java.md b/docs/team.java.md new file mode 100644 index 000000000..df7085fff --- /dev/null +++ b/docs/team.java.md @@ -0,0 +1,1451 @@ +# `team` Submodule + +## Constructs + +### Team + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team github_team}. + +#### Initializers + +```java +import io.cdktn.providers.github.team.Team; + +Team.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .name(java.lang.String) +// .createDefaultMaintainer(java.lang.Boolean|IResolvable) +// .description(java.lang.String) +// .id(java.lang.String) +// .ldapDn(java.lang.String) +// .notificationSetting(java.lang.String) +// .parentTeamId(java.lang.String) +// .parentTeamReadId(java.lang.String) +// .parentTeamReadSlug(java.lang.String) +// .privacy(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 | *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 | *No description.* | +| name | java.lang.String | The name of the team. | +| createDefaultMaintainer | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Adds a default maintainer to the team. Adds the creating user to the team when 'true'. | +| description | java.lang.String | A description of the team. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#id Team#id}. | +| ldapDn | java.lang.String | The LDAP Distinguished Name of the group where membership will be synchronized. Only available in GitHub Enterprise Server. | +| notificationSetting | java.lang.String | The notification setting for the team. Must be one of 'notifications_enabled' or 'notifications_disabled'. | +| parentTeamId | java.lang.String | The ID or slug of the parent team, if this is a nested team. | +| parentTeamReadId | java.lang.String | The id of the parent team read in Github. | +| parentTeamReadSlug | java.lang.String | The id of the parent team read in Github. | +| privacy | java.lang.String | The level of privacy for the team. Must be one of 'secret' or 'closed'. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `name`Required + +- *Type:* java.lang.String + +The name of the team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#name Team#name} + +--- + +##### `createDefaultMaintainer`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Adds a default maintainer to the team. Adds the creating user to the team when 'true'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#create_default_maintainer Team#create_default_maintainer} + +--- + +##### `description`Optional + +- *Type:* java.lang.String + +A description of the team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#description Team#description} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#id Team#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. + +--- + +##### `ldapDn`Optional + +- *Type:* java.lang.String + +The LDAP Distinguished Name of the group where membership will be synchronized. Only available in GitHub Enterprise Server. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#ldap_dn Team#ldap_dn} + +--- + +##### `notificationSetting`Optional + +- *Type:* java.lang.String + +The notification setting for the team. Must be one of 'notifications_enabled' or 'notifications_disabled'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#notification_setting Team#notification_setting} + +--- + +##### `parentTeamId`Optional + +- *Type:* java.lang.String + +The ID or slug of the parent team, if this is a nested team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#parent_team_id Team#parent_team_id} + +--- + +##### `parentTeamReadId`Optional + +- *Type:* java.lang.String + +The id of the parent team read in Github. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#parent_team_read_id Team#parent_team_read_id} + +--- + +##### `parentTeamReadSlug`Optional + +- *Type:* java.lang.String + +The id of the parent team read in Github. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#parent_team_read_slug Team#parent_team_read_slug} + +--- + +##### `privacy`Optional + +- *Type:* java.lang.String + +The level of privacy for the team. Must be one of 'secret' or 'closed'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#privacy Team#privacy} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetCreateDefaultMaintainer | *No description.* | +| resetDescription | *No description.* | +| resetId | *No description.* | +| resetLdapDn | *No description.* | +| resetNotificationSetting | *No description.* | +| resetParentTeamId | *No description.* | +| resetParentTeamReadId | *No description.* | +| resetParentTeamReadSlug | *No description.* | +| resetPrivacy | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetCreateDefaultMaintainer` + +```java +public void resetCreateDefaultMaintainer() +``` + +##### `resetDescription` + +```java +public void resetDescription() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetLdapDn` + +```java +public void resetLdapDn() +``` + +##### `resetNotificationSetting` + +```java +public void resetNotificationSetting() +``` + +##### `resetParentTeamId` + +```java +public void resetParentTeamId() +``` + +##### `resetParentTeamReadId` + +```java +public void resetParentTeamReadId() +``` + +##### `resetParentTeamReadSlug` + +```java +public void resetParentTeamReadSlug() +``` + +##### `resetPrivacy` + +```java +public void resetPrivacy() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a Team resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.team.Team; + +Team.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` + +```java +import io.cdktn.providers.github.team.Team; + +Team.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.team.Team; + +Team.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.team.Team; + +Team.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),Team.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a Team 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 Team to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing Team that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#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 Team 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| etag | java.lang.String | *No description.* | +| membersCount | java.lang.Number | *No description.* | +| nodeId | java.lang.String | *No description.* | +| slug | java.lang.String | *No description.* | +| createDefaultMaintainerInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| descriptionInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| ldapDnInput | java.lang.String | *No description.* | +| nameInput | java.lang.String | *No description.* | +| notificationSettingInput | java.lang.String | *No description.* | +| parentTeamIdInput | java.lang.String | *No description.* | +| parentTeamReadIdInput | java.lang.String | *No description.* | +| parentTeamReadSlugInput | java.lang.String | *No description.* | +| privacyInput | java.lang.String | *No description.* | +| createDefaultMaintainer | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| description | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| ldapDn | java.lang.String | *No description.* | +| name | java.lang.String | *No description.* | +| notificationSetting | java.lang.String | *No description.* | +| parentTeamId | java.lang.String | *No description.* | +| parentTeamReadId | java.lang.String | *No description.* | +| parentTeamReadSlug | java.lang.String | *No description.* | +| privacy | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `membersCount`Required + +```java +public java.lang.Number getMembersCount(); +``` + +- *Type:* java.lang.Number + +--- + +##### `nodeId`Required + +```java +public java.lang.String getNodeId(); +``` + +- *Type:* java.lang.String + +--- + +##### `slug`Required + +```java +public java.lang.String getSlug(); +``` + +- *Type:* java.lang.String + +--- + +##### `createDefaultMaintainerInput`Optional + +```java +public java.lang.Boolean|IResolvable getCreateDefaultMaintainerInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `descriptionInput`Optional + +```java +public java.lang.String getDescriptionInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `ldapDnInput`Optional + +```java +public java.lang.String getLdapDnInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `nameInput`Optional + +```java +public java.lang.String getNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `notificationSettingInput`Optional + +```java +public java.lang.String getNotificationSettingInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `parentTeamIdInput`Optional + +```java +public java.lang.String getParentTeamIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `parentTeamReadIdInput`Optional + +```java +public java.lang.String getParentTeamReadIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `parentTeamReadSlugInput`Optional + +```java +public java.lang.String getParentTeamReadSlugInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `privacyInput`Optional + +```java +public java.lang.String getPrivacyInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `createDefaultMaintainer`Required + +```java +public java.lang.Boolean|IResolvable getCreateDefaultMaintainer(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `description`Required + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `ldapDn`Required + +```java +public java.lang.String getLdapDn(); +``` + +- *Type:* java.lang.String + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +--- + +##### `notificationSetting`Required + +```java +public java.lang.String getNotificationSetting(); +``` + +- *Type:* java.lang.String + +--- + +##### `parentTeamId`Required + +```java +public java.lang.String getParentTeamId(); +``` + +- *Type:* java.lang.String + +--- + +##### `parentTeamReadId`Required + +```java +public java.lang.String getParentTeamReadId(); +``` + +- *Type:* java.lang.String + +--- + +##### `parentTeamReadSlug`Required + +```java +public java.lang.String getParentTeamReadSlug(); +``` + +- *Type:* java.lang.String + +--- + +##### `privacy`Required + +```java +public java.lang.String getPrivacy(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### TeamConfig + +#### Initializer + +```java +import io.cdktn.providers.github.team.TeamConfig; + +TeamConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .name(java.lang.String) +// .createDefaultMaintainer(java.lang.Boolean|IResolvable) +// .description(java.lang.String) +// .id(java.lang.String) +// .ldapDn(java.lang.String) +// .notificationSetting(java.lang.String) +// .parentTeamId(java.lang.String) +// .parentTeamReadId(java.lang.String) +// .parentTeamReadSlug(java.lang.String) +// .privacy(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 | *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 | *No description.* | +| name | java.lang.String | The name of the team. | +| createDefaultMaintainer | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Adds a default maintainer to the team. Adds the creating user to the team when 'true'. | +| description | java.lang.String | A description of the team. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#id Team#id}. | +| ldapDn | java.lang.String | The LDAP Distinguished Name of the group where membership will be synchronized. Only available in GitHub Enterprise Server. | +| notificationSetting | java.lang.String | The notification setting for the team. Must be one of 'notifications_enabled' or 'notifications_disabled'. | +| parentTeamId | java.lang.String | The ID or slug of the parent team, if this is a nested team. | +| parentTeamReadId | java.lang.String | The id of the parent team read in Github. | +| parentTeamReadSlug | java.lang.String | The id of the parent team read in Github. | +| privacy | java.lang.String | The level of privacy for the team. Must be one of 'secret' or 'closed'. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `name`Required + +```java +public java.lang.String getName(); +``` + +- *Type:* java.lang.String + +The name of the team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#name Team#name} + +--- + +##### `createDefaultMaintainer`Optional + +```java +public java.lang.Boolean|IResolvable getCreateDefaultMaintainer(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Adds a default maintainer to the team. Adds the creating user to the team when 'true'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#create_default_maintainer Team#create_default_maintainer} + +--- + +##### `description`Optional + +```java +public java.lang.String getDescription(); +``` + +- *Type:* java.lang.String + +A description of the team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#description Team#description} + +--- + +##### `id`Optional + +```java +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/resources/team#id Team#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. + +--- + +##### `ldapDn`Optional + +```java +public java.lang.String getLdapDn(); +``` + +- *Type:* java.lang.String + +The LDAP Distinguished Name of the group where membership will be synchronized. Only available in GitHub Enterprise Server. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#ldap_dn Team#ldap_dn} + +--- + +##### `notificationSetting`Optional + +```java +public java.lang.String getNotificationSetting(); +``` + +- *Type:* java.lang.String + +The notification setting for the team. Must be one of 'notifications_enabled' or 'notifications_disabled'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#notification_setting Team#notification_setting} + +--- + +##### `parentTeamId`Optional + +```java +public java.lang.String getParentTeamId(); +``` + +- *Type:* java.lang.String + +The ID or slug of the parent team, if this is a nested team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#parent_team_id Team#parent_team_id} + +--- + +##### `parentTeamReadId`Optional + +```java +public java.lang.String getParentTeamReadId(); +``` + +- *Type:* java.lang.String + +The id of the parent team read in Github. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#parent_team_read_id Team#parent_team_read_id} + +--- + +##### `parentTeamReadSlug`Optional + +```java +public java.lang.String getParentTeamReadSlug(); +``` + +- *Type:* java.lang.String + +The id of the parent team read in Github. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#parent_team_read_slug Team#parent_team_read_slug} + +--- + +##### `privacy`Optional + +```java +public java.lang.String getPrivacy(); +``` + +- *Type:* java.lang.String + +The level of privacy for the team. Must be one of 'secret' or 'closed'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team#privacy Team#privacy} + +--- + + + diff --git a/docs/teamMembers.csharp.md b/docs/teamMembers.csharp.md new file mode 100644 index 000000000..9c0018f9e --- /dev/null +++ b/docs/teamMembers.csharp.md @@ -0,0 +1,1454 @@ +# `teamMembers` Submodule + +## Constructs + +### TeamMembers + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_members github_team_members}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new TeamMembers(Construct Scope, string Id, TeamMembersConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | TeamMembersConfig | *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:* TeamMembersConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| PutMembers | *No description.* | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `PutMembers` + +```csharp +private void PutMembers(IResolvable|TeamMembersMembers[] Value) +``` + +###### `Value`Required + +- *Type:* Io.Cdktn.IResolvable|TeamMembersMembers[] + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a TeamMembers resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +TeamMembers.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` + +```csharp +using Io.Cdktn.Providers.Github; + +TeamMembers.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +TeamMembers.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +TeamMembers.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a TeamMembers resource upon running "cdktn 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 TeamMembers to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing TeamMembers that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_members#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the TeamMembers to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Members | TeamMembersMembersList | *No description.* | +| IdInput | string | *No description.* | +| MembersInput | Io.Cdktn.IResolvable\|TeamMembersMembers[] | *No description.* | +| TeamIdInput | string | *No description.* | +| Id | string | *No description.* | +| TeamId | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Members`Required + +```csharp +public TeamMembersMembersList Members { get; } +``` + +- *Type:* TeamMembersMembersList + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `MembersInput`Optional + +```csharp +public IResolvable|TeamMembersMembers[] MembersInput { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|TeamMembersMembers[] + +--- + +##### `TeamIdInput`Optional + +```csharp +public string TeamIdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `TeamId`Required + +```csharp +public string TeamId { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### TeamMembersConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new TeamMembersConfig { + 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, + IResolvable|TeamMembersMembers[] Members, + string TeamId, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Members | Io.Cdktn.IResolvable\|TeamMembersMembers[] | members block. | +| TeamId | string | The GitHub team id or slug. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_members#id TeamMembers#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Members`Required + +```csharp +public IResolvable|TeamMembersMembers[] Members { get; set; } +``` + +- *Type:* Io.Cdktn.IResolvable|TeamMembersMembers[] + +members block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_members#members TeamMembers#members} + +--- + +##### `TeamId`Required + +```csharp +public string TeamId { get; set; } +``` + +- *Type:* string + +The GitHub team id or slug. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_members#team_id TeamMembers#team_id} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_members#id TeamMembers#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. + +--- + +### TeamMembersMembers + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new TeamMembersMembers { + string Username, + string Role = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Username | string | The user to add to the team. | +| Role | string | The role of the user within the team. Must be one of 'member' or 'maintainer'. | + +--- + +##### `Username`Required + +```csharp +public string Username { get; set; } +``` + +- *Type:* string + +The user to add to the team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_members#username TeamMembers#username} + +--- + +##### `Role`Optional + +```csharp +public string Role { get; set; } +``` + +- *Type:* string + +The role of the user within the team. Must be one of 'member' or 'maintainer'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_members#role TeamMembers#role} + +--- + +## Classes + +### TeamMembersMembersList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new TeamMembersMembersList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private TeamMembersMembersOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|TeamMembersMembers[] | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|TeamMembersMembers[] InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|TeamMembersMembers[] + +--- + + +### TeamMembersMembersOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new TeamMembersMembersOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetRole | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetRole` + +```csharp +private void ResetRole() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| RoleInput | string | *No description.* | +| UsernameInput | string | *No description.* | +| Role | string | *No description.* | +| Username | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|TeamMembersMembers | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `RoleInput`Optional + +```csharp +public string RoleInput { get; } +``` + +- *Type:* string + +--- + +##### `UsernameInput`Optional + +```csharp +public string UsernameInput { get; } +``` + +- *Type:* string + +--- + +##### `Role`Required + +```csharp +public string Role { get; } +``` + +- *Type:* string + +--- + +##### `Username`Required + +```csharp +public string Username { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|TeamMembersMembers InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|TeamMembersMembers + +--- + + + diff --git a/docs/teamMembers.java.md b/docs/teamMembers.java.md new file mode 100644 index 000000000..876c5702b --- /dev/null +++ b/docs/teamMembers.java.md @@ -0,0 +1,1543 @@ +# `teamMembers` Submodule + +## Constructs + +### TeamMembers + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_members github_team_members}. + +#### Initializers + +```java +import io.cdktn.providers.github.team_members.TeamMembers; + +TeamMembers.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .members(IResolvable|java.util.List) + .teamId(java.lang.String) +// .id(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 | *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 | *No description.* | +| members | io.cdktn.cdktn.IResolvable\|java.util.List<TeamMembersMembers> | members block. | +| teamId | java.lang.String | The GitHub team id or slug. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_members#id TeamMembers#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `members`Required + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<TeamMembersMembers> + +members block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_members#members TeamMembers#members} + +--- + +##### `teamId`Required + +- *Type:* java.lang.String + +The GitHub team id or slug. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_members#team_id TeamMembers#team_id} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_members#id TeamMembers#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| putMembers | *No description.* | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `putMembers` + +```java +public void putMembers(IResolvable|java.util.List value) +``` + +###### `value`Required + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<TeamMembersMembers> + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a TeamMembers resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.team_members.TeamMembers; + +TeamMembers.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` + +```java +import io.cdktn.providers.github.team_members.TeamMembers; + +TeamMembers.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.team_members.TeamMembers; + +TeamMembers.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.team_members.TeamMembers; + +TeamMembers.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),TeamMembers.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a TeamMembers 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 TeamMembers to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing TeamMembers that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_members#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 TeamMembers 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| members | TeamMembersMembersList | *No description.* | +| idInput | java.lang.String | *No description.* | +| membersInput | io.cdktn.cdktn.IResolvable\|java.util.List<TeamMembersMembers> | *No description.* | +| teamIdInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| teamId | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `members`Required + +```java +public TeamMembersMembersList getMembers(); +``` + +- *Type:* TeamMembersMembersList + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `membersInput`Optional + +```java +public IResolvable|java.util.List getMembersInput(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<TeamMembersMembers> + +--- + +##### `teamIdInput`Optional + +```java +public java.lang.String getTeamIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `teamId`Required + +```java +public java.lang.String getTeamId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### TeamMembersConfig + +#### Initializer + +```java +import io.cdktn.providers.github.team_members.TeamMembersConfig; + +TeamMembersConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .members(IResolvable|java.util.List) + .teamId(java.lang.String) +// .id(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 | *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 | *No description.* | +| members | io.cdktn.cdktn.IResolvable\|java.util.List<TeamMembersMembers> | members block. | +| teamId | java.lang.String | The GitHub team id or slug. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_members#id TeamMembers#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `members`Required + +```java +public IResolvable|java.util.List getMembers(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<TeamMembersMembers> + +members block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_members#members TeamMembers#members} + +--- + +##### `teamId`Required + +```java +public java.lang.String getTeamId(); +``` + +- *Type:* java.lang.String + +The GitHub team id or slug. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_members#team_id TeamMembers#team_id} + +--- + +##### `id`Optional + +```java +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/resources/team_members#id TeamMembers#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. + +--- + +### TeamMembersMembers + +#### Initializer + +```java +import io.cdktn.providers.github.team_members.TeamMembersMembers; + +TeamMembersMembers.builder() + .username(java.lang.String) +// .role(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| username | java.lang.String | The user to add to the team. | +| role | java.lang.String | The role of the user within the team. Must be one of 'member' or 'maintainer'. | + +--- + +##### `username`Required + +```java +public java.lang.String getUsername(); +``` + +- *Type:* java.lang.String + +The user to add to the team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_members#username TeamMembers#username} + +--- + +##### `role`Optional + +```java +public java.lang.String getRole(); +``` + +- *Type:* java.lang.String + +The role of the user within the team. Must be one of 'member' or 'maintainer'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_members#role TeamMembers#role} + +--- + +## Classes + +### TeamMembersMembersList + +#### Initializers + +```java +import io.cdktn.providers.github.team_members.TeamMembersMembersList; + +new TeamMembersMembersList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public TeamMembersMembersOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|java.util.List<TeamMembersMembers> | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|java.util.List getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<TeamMembersMembers> + +--- + + +### TeamMembersMembersOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.team_members.TeamMembersMembersOutputReference; + +new TeamMembersMembersOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetRole | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetRole` + +```java +public void resetRole() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| roleInput | java.lang.String | *No description.* | +| usernameInput | java.lang.String | *No description.* | +| role | java.lang.String | *No description.* | +| username | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|TeamMembersMembers | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `roleInput`Optional + +```java +public java.lang.String getRoleInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `usernameInput`Optional + +```java +public java.lang.String getUsernameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `role`Required + +```java +public java.lang.String getRole(); +``` + +- *Type:* java.lang.String + +--- + +##### `username`Required + +```java +public java.lang.String getUsername(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|TeamMembersMembers getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|TeamMembersMembers + +--- + + + diff --git a/docs/teamMembership.csharp.md b/docs/teamMembership.csharp.md new file mode 100644 index 000000000..e372a14f4 --- /dev/null +++ b/docs/teamMembership.csharp.md @@ -0,0 +1,968 @@ +# `teamMembership` Submodule + +## Constructs + +### TeamMembership + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_membership github_team_membership}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new TeamMembership(Construct Scope, string Id, TeamMembershipConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | TeamMembershipConfig | *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:* TeamMembershipConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | +| ResetRole | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetRole` + +```csharp +private void ResetRole() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a TeamMembership resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +TeamMembership.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` + +```csharp +using Io.Cdktn.Providers.Github; + +TeamMembership.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +TeamMembership.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +TeamMembership.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a TeamMembership resource upon running "cdktn 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 TeamMembership to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing TeamMembership that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_membership#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the TeamMembership to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Etag | string | *No description.* | +| IdInput | string | *No description.* | +| RoleInput | string | *No description.* | +| TeamIdInput | string | *No description.* | +| UsernameInput | string | *No description.* | +| Id | string | *No description.* | +| Role | string | *No description.* | +| TeamId | string | *No description.* | +| Username | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RoleInput`Optional + +```csharp +public string RoleInput { get; } +``` + +- *Type:* string + +--- + +##### `TeamIdInput`Optional + +```csharp +public string TeamIdInput { get; } +``` + +- *Type:* string + +--- + +##### `UsernameInput`Optional + +```csharp +public string UsernameInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Role`Required + +```csharp +public string Role { get; } +``` + +- *Type:* string + +--- + +##### `TeamId`Required + +```csharp +public string TeamId { get; } +``` + +- *Type:* string + +--- + +##### `Username`Required + +```csharp +public string Username { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### TeamMembershipConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new TeamMembershipConfig { + 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 TeamId, + string Username, + string Id = null, + string Role = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| TeamId | string | The GitHub team id or the GitHub team slug. | +| Username | string | The user to add to the team. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_membership#id TeamMembership#id}. | +| Role | string | The role of the user within the team. Must be one of 'member' or 'maintainer'. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `TeamId`Required + +```csharp +public string TeamId { get; set; } +``` + +- *Type:* string + +The GitHub team id or the GitHub team slug. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_membership#team_id TeamMembership#team_id} + +--- + +##### `Username`Required + +```csharp +public string Username { get; set; } +``` + +- *Type:* string + +The user to add to the team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_membership#username TeamMembership#username} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_membership#id TeamMembership#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. + +--- + +##### `Role`Optional + +```csharp +public string Role { get; set; } +``` + +- *Type:* string + +The role of the user within the team. Must be one of 'member' or 'maintainer'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_membership#role TeamMembership#role} + +--- + + + diff --git a/docs/teamMembership.java.md b/docs/teamMembership.java.md new file mode 100644 index 000000000..e74325042 --- /dev/null +++ b/docs/teamMembership.java.md @@ -0,0 +1,1069 @@ +# `teamMembership` Submodule + +## Constructs + +### TeamMembership + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_membership github_team_membership}. + +#### Initializers + +```java +import io.cdktn.providers.github.team_membership.TeamMembership; + +TeamMembership.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .teamId(java.lang.String) + .username(java.lang.String) +// .id(java.lang.String) +// .role(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 | *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 | *No description.* | +| teamId | java.lang.String | The GitHub team id or the GitHub team slug. | +| username | java.lang.String | The user to add to the team. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_membership#id TeamMembership#id}. | +| role | java.lang.String | The role of the user within the team. Must be one of 'member' or 'maintainer'. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `teamId`Required + +- *Type:* java.lang.String + +The GitHub team id or the GitHub team slug. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_membership#team_id TeamMembership#team_id} + +--- + +##### `username`Required + +- *Type:* java.lang.String + +The user to add to the team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_membership#username TeamMembership#username} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_membership#id TeamMembership#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. + +--- + +##### `role`Optional + +- *Type:* java.lang.String + +The role of the user within the team. Must be one of 'member' or 'maintainer'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_membership#role TeamMembership#role} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | +| resetRole | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetRole` + +```java +public void resetRole() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a TeamMembership resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.team_membership.TeamMembership; + +TeamMembership.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` + +```java +import io.cdktn.providers.github.team_membership.TeamMembership; + +TeamMembership.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.team_membership.TeamMembership; + +TeamMembership.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.team_membership.TeamMembership; + +TeamMembership.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),TeamMembership.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a TeamMembership 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 TeamMembership to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing TeamMembership that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_membership#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 TeamMembership 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| etag | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| roleInput | java.lang.String | *No description.* | +| teamIdInput | java.lang.String | *No description.* | +| usernameInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| role | java.lang.String | *No description.* | +| teamId | java.lang.String | *No description.* | +| username | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `roleInput`Optional + +```java +public java.lang.String getRoleInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `teamIdInput`Optional + +```java +public java.lang.String getTeamIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `usernameInput`Optional + +```java +public java.lang.String getUsernameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `role`Required + +```java +public java.lang.String getRole(); +``` + +- *Type:* java.lang.String + +--- + +##### `teamId`Required + +```java +public java.lang.String getTeamId(); +``` + +- *Type:* java.lang.String + +--- + +##### `username`Required + +```java +public java.lang.String getUsername(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### TeamMembershipConfig + +#### Initializer + +```java +import io.cdktn.providers.github.team_membership.TeamMembershipConfig; + +TeamMembershipConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .teamId(java.lang.String) + .username(java.lang.String) +// .id(java.lang.String) +// .role(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 | *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 | *No description.* | +| teamId | java.lang.String | The GitHub team id or the GitHub team slug. | +| username | java.lang.String | The user to add to the team. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_membership#id TeamMembership#id}. | +| role | java.lang.String | The role of the user within the team. Must be one of 'member' or 'maintainer'. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `teamId`Required + +```java +public java.lang.String getTeamId(); +``` + +- *Type:* java.lang.String + +The GitHub team id or the GitHub team slug. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_membership#team_id TeamMembership#team_id} + +--- + +##### `username`Required + +```java +public java.lang.String getUsername(); +``` + +- *Type:* java.lang.String + +The user to add to the team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_membership#username TeamMembership#username} + +--- + +##### `id`Optional + +```java +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/resources/team_membership#id TeamMembership#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. + +--- + +##### `role`Optional + +```java +public java.lang.String getRole(); +``` + +- *Type:* java.lang.String + +The role of the user within the team. Must be one of 'member' or 'maintainer'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_membership#role TeamMembership#role} + +--- + + + diff --git a/docs/teamRepository.csharp.md b/docs/teamRepository.csharp.md new file mode 100644 index 000000000..a5d86a78e --- /dev/null +++ b/docs/teamRepository.csharp.md @@ -0,0 +1,970 @@ +# `teamRepository` Submodule + +## Constructs + +### TeamRepository + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_repository github_team_repository}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new TeamRepository(Construct Scope, string Id, TeamRepositoryConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | TeamRepositoryConfig | *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:* TeamRepositoryConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | +| ResetPermission | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetPermission` + +```csharp +private void ResetPermission() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a TeamRepository resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +TeamRepository.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` + +```csharp +using Io.Cdktn.Providers.Github; + +TeamRepository.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +TeamRepository.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +TeamRepository.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a TeamRepository resource upon running "cdktn 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 TeamRepository to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing TeamRepository that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_repository#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the TeamRepository to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Etag | string | *No description.* | +| IdInput | string | *No description.* | +| PermissionInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| TeamIdInput | string | *No description.* | +| Id | string | *No description.* | +| Permission | string | *No description.* | +| Repository | string | *No description.* | +| TeamId | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `PermissionInput`Optional + +```csharp +public string PermissionInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `TeamIdInput`Optional + +```csharp +public string TeamIdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Permission`Required + +```csharp +public string Permission { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +##### `TeamId`Required + +```csharp +public string TeamId { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### TeamRepositoryConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new TeamRepositoryConfig { + 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 Repository, + string TeamId, + string Id = null, + string Permission = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | The repository to add to the team. | +| TeamId | string | ID or slug of team. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_repository#id TeamRepository#id}. | +| Permission | string | The permissions of team members regarding the repository. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The repository to add to the team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_repository#repository TeamRepository#repository} + +--- + +##### `TeamId`Required + +```csharp +public string TeamId { get; set; } +``` + +- *Type:* string + +ID or slug of team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_repository#team_id TeamRepository#team_id} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_repository#id TeamRepository#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. + +--- + +##### `Permission`Optional + +```csharp +public string Permission { get; set; } +``` + +- *Type:* string + +The permissions of team members regarding the repository. + +Must be one of 'pull', 'triage', 'push', 'maintain', 'admin' or the name of an existing custom repository role within the organisation. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_repository#permission TeamRepository#permission} + +--- + + + diff --git a/docs/teamRepository.java.md b/docs/teamRepository.java.md new file mode 100644 index 000000000..ff686a9db --- /dev/null +++ b/docs/teamRepository.java.md @@ -0,0 +1,1073 @@ +# `teamRepository` Submodule + +## Constructs + +### TeamRepository + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_repository github_team_repository}. + +#### Initializers + +```java +import io.cdktn.providers.github.team_repository.TeamRepository; + +TeamRepository.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) + .teamId(java.lang.String) +// .id(java.lang.String) +// .permission(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 | *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 | *No description.* | +| repository | java.lang.String | The repository to add to the team. | +| teamId | java.lang.String | ID or slug of team. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_repository#id TeamRepository#id}. | +| permission | java.lang.String | The permissions of team members regarding the repository. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The repository to add to the team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_repository#repository TeamRepository#repository} + +--- + +##### `teamId`Required + +- *Type:* java.lang.String + +ID or slug of team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_repository#team_id TeamRepository#team_id} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_repository#id TeamRepository#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. + +--- + +##### `permission`Optional + +- *Type:* java.lang.String + +The permissions of team members regarding the repository. + +Must be one of 'pull', 'triage', 'push', 'maintain', 'admin' or the name of an existing custom repository role within the organisation. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_repository#permission TeamRepository#permission} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | +| resetPermission | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetPermission` + +```java +public void resetPermission() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a TeamRepository resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.team_repository.TeamRepository; + +TeamRepository.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` + +```java +import io.cdktn.providers.github.team_repository.TeamRepository; + +TeamRepository.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.team_repository.TeamRepository; + +TeamRepository.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.team_repository.TeamRepository; + +TeamRepository.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),TeamRepository.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a TeamRepository 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 TeamRepository to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing TeamRepository that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_repository#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 TeamRepository 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| etag | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| permissionInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| teamIdInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| permission | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | +| teamId | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `permissionInput`Optional + +```java +public java.lang.String getPermissionInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `teamIdInput`Optional + +```java +public java.lang.String getTeamIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `permission`Required + +```java +public java.lang.String getPermission(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +##### `teamId`Required + +```java +public java.lang.String getTeamId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### TeamRepositoryConfig + +#### Initializer + +```java +import io.cdktn.providers.github.team_repository.TeamRepositoryConfig; + +TeamRepositoryConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) + .teamId(java.lang.String) +// .id(java.lang.String) +// .permission(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 | *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 | *No description.* | +| repository | java.lang.String | The repository to add to the team. | +| teamId | java.lang.String | ID or slug of team. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_repository#id TeamRepository#id}. | +| permission | java.lang.String | The permissions of team members regarding the repository. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The repository to add to the team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_repository#repository TeamRepository#repository} + +--- + +##### `teamId`Required + +```java +public java.lang.String getTeamId(); +``` + +- *Type:* java.lang.String + +ID or slug of team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_repository#team_id TeamRepository#team_id} + +--- + +##### `id`Optional + +```java +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/resources/team_repository#id TeamRepository#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. + +--- + +##### `permission`Optional + +```java +public java.lang.String getPermission(); +``` + +- *Type:* java.lang.String + +The permissions of team members regarding the repository. + +Must be one of 'pull', 'triage', 'push', 'maintain', 'admin' or the name of an existing custom repository role within the organisation. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_repository#permission TeamRepository#permission} + +--- + + + diff --git a/docs/teamSettings.csharp.md b/docs/teamSettings.csharp.md new file mode 100644 index 000000000..bf6fadfa9 --- /dev/null +++ b/docs/teamSettings.csharp.md @@ -0,0 +1,1402 @@ +# `teamSettings` Submodule + +## Constructs + +### TeamSettings + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings github_team_settings}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new TeamSettings(Construct Scope, string Id, TeamSettingsConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | TeamSettingsConfig | *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:* TeamSettingsConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| PutReviewRequestDelegation | *No description.* | +| ResetId | *No description.* | +| ResetNotify | *No description.* | +| ResetReviewRequestDelegation | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `PutReviewRequestDelegation` + +```csharp +private void PutReviewRequestDelegation(TeamSettingsReviewRequestDelegation Value) +``` + +###### `Value`Required + +- *Type:* TeamSettingsReviewRequestDelegation + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetNotify` + +```csharp +private void ResetNotify() +``` + +##### `ResetReviewRequestDelegation` + +```csharp +private void ResetReviewRequestDelegation() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a TeamSettings resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +TeamSettings.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` + +```csharp +using Io.Cdktn.Providers.Github; + +TeamSettings.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +TeamSettings.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +TeamSettings.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a TeamSettings resource upon running "cdktn 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 TeamSettings to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing TeamSettings that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the TeamSettings to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| ReviewRequestDelegation | TeamSettingsReviewRequestDelegationOutputReference | *No description.* | +| TeamSlug | string | *No description.* | +| TeamUid | string | *No description.* | +| IdInput | string | *No description.* | +| NotifyInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| ReviewRequestDelegationInput | TeamSettingsReviewRequestDelegation | *No description.* | +| TeamIdInput | string | *No description.* | +| Id | string | *No description.* | +| Notify | bool\|Io.Cdktn.IResolvable | *No description.* | +| TeamId | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `ReviewRequestDelegation`Required + +```csharp +public TeamSettingsReviewRequestDelegationOutputReference ReviewRequestDelegation { get; } +``` + +- *Type:* TeamSettingsReviewRequestDelegationOutputReference + +--- + +##### `TeamSlug`Required + +```csharp +public string TeamSlug { get; } +``` + +- *Type:* string + +--- + +##### `TeamUid`Required + +```csharp +public string TeamUid { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `NotifyInput`Optional + +```csharp +public bool|IResolvable NotifyInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `ReviewRequestDelegationInput`Optional + +```csharp +public TeamSettingsReviewRequestDelegation ReviewRequestDelegationInput { get; } +``` + +- *Type:* TeamSettingsReviewRequestDelegation + +--- + +##### `TeamIdInput`Optional + +```csharp +public string TeamIdInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Notify`Required + +```csharp +public bool|IResolvable Notify { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `TeamId`Required + +```csharp +public string TeamId { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### TeamSettingsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new TeamSettingsConfig { + 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 TeamId, + string Id = null, + bool|IResolvable Notify = null, + TeamSettingsReviewRequestDelegation ReviewRequestDelegation = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| TeamId | string | The GitHub team id or the GitHub team slug. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings#id TeamSettings#id}. | +| Notify | bool\|Io.Cdktn.IResolvable | Whether to notify the entire team when at least one member is also assigned to the pull request. | +| ReviewRequestDelegation | TeamSettingsReviewRequestDelegation | review_request_delegation block. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `TeamId`Required + +```csharp +public string TeamId { get; set; } +``` + +- *Type:* string + +The GitHub team id or the GitHub team slug. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings#team_id TeamSettings#team_id} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings#id TeamSettings#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. + +--- + +##### `Notify`Optional + +```csharp +public bool|IResolvable Notify { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether to notify the entire team when at least one member is also assigned to the pull request. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings#notify TeamSettings#notify} + +--- + +##### `ReviewRequestDelegation`Optional + +```csharp +public TeamSettingsReviewRequestDelegation ReviewRequestDelegation { get; set; } +``` + +- *Type:* TeamSettingsReviewRequestDelegation + +review_request_delegation block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings#review_request_delegation TeamSettings#review_request_delegation} + +--- + +### TeamSettingsReviewRequestDelegation + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new TeamSettingsReviewRequestDelegation { + string Algorithm = null, + double MemberCount = null, + bool|IResolvable Notify = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Algorithm | string | The algorithm to use when assigning pull requests to team members. Supported values are ROUND_ROBIN and LOAD_BALANCE. | +| MemberCount | double | The number of team members to assign to a pull request. | +| Notify | bool\|Io.Cdktn.IResolvable | whether to notify the entire team when at least one member is also assigned to the pull request. | + +--- + +##### `Algorithm`Optional + +```csharp +public string Algorithm { get; set; } +``` + +- *Type:* string + +The algorithm to use when assigning pull requests to team members. Supported values are ROUND_ROBIN and LOAD_BALANCE. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings#algorithm TeamSettings#algorithm} + +--- + +##### `MemberCount`Optional + +```csharp +public double MemberCount { get; set; } +``` + +- *Type:* double + +The number of team members to assign to a pull request. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings#member_count TeamSettings#member_count} + +--- + +##### `Notify`Optional + +```csharp +public bool|IResolvable Notify { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +whether to notify the entire team when at least one member is also assigned to the pull request. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings#notify TeamSettings#notify} + +--- + +## Classes + +### TeamSettingsReviewRequestDelegationOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new TeamSettingsReviewRequestDelegationOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| ResetAlgorithm | *No description.* | +| ResetMemberCount | *No description.* | +| ResetNotify | *No description.* | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `ResetAlgorithm` + +```csharp +private void ResetAlgorithm() +``` + +##### `ResetMemberCount` + +```csharp +private void ResetMemberCount() +``` + +##### `ResetNotify` + +```csharp +private void ResetNotify() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| AlgorithmInput | string | *No description.* | +| MemberCountInput | double | *No description.* | +| NotifyInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| Algorithm | string | *No description.* | +| MemberCount | double | *No description.* | +| Notify | bool\|Io.Cdktn.IResolvable | *No description.* | +| InternalValue | TeamSettingsReviewRequestDelegation | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `AlgorithmInput`Optional + +```csharp +public string AlgorithmInput { get; } +``` + +- *Type:* string + +--- + +##### `MemberCountInput`Optional + +```csharp +public double MemberCountInput { get; } +``` + +- *Type:* double + +--- + +##### `NotifyInput`Optional + +```csharp +public bool|IResolvable NotifyInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Algorithm`Required + +```csharp +public string Algorithm { get; } +``` + +- *Type:* string + +--- + +##### `MemberCount`Required + +```csharp +public double MemberCount { get; } +``` + +- *Type:* double + +--- + +##### `Notify`Required + +```csharp +public bool|IResolvable Notify { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `InternalValue`Optional + +```csharp +public TeamSettingsReviewRequestDelegation InternalValue { get; } +``` + +- *Type:* TeamSettingsReviewRequestDelegation + +--- + + + diff --git a/docs/teamSettings.java.md b/docs/teamSettings.java.md new file mode 100644 index 000000000..bc21a0482 --- /dev/null +++ b/docs/teamSettings.java.md @@ -0,0 +1,1503 @@ +# `teamSettings` Submodule + +## Constructs + +### TeamSettings + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings github_team_settings}. + +#### Initializers + +```java +import io.cdktn.providers.github.team_settings.TeamSettings; + +TeamSettings.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .teamId(java.lang.String) +// .id(java.lang.String) +// .notify(java.lang.Boolean|IResolvable) +// .reviewRequestDelegation(TeamSettingsReviewRequestDelegation) + .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 | *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 | *No description.* | +| teamId | java.lang.String | The GitHub team id or the GitHub team slug. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings#id TeamSettings#id}. | +| notify | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether to notify the entire team when at least one member is also assigned to the pull request. | +| reviewRequestDelegation | TeamSettingsReviewRequestDelegation | review_request_delegation block. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `teamId`Required + +- *Type:* java.lang.String + +The GitHub team id or the GitHub team slug. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings#team_id TeamSettings#team_id} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings#id TeamSettings#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. + +--- + +##### `notify`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether to notify the entire team when at least one member is also assigned to the pull request. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings#notify TeamSettings#notify} + +--- + +##### `reviewRequestDelegation`Optional + +- *Type:* TeamSettingsReviewRequestDelegation + +review_request_delegation block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings#review_request_delegation TeamSettings#review_request_delegation} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| putReviewRequestDelegation | *No description.* | +| resetId | *No description.* | +| resetNotify | *No description.* | +| resetReviewRequestDelegation | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `putReviewRequestDelegation` + +```java +public void putReviewRequestDelegation(TeamSettingsReviewRequestDelegation value) +``` + +###### `value`Required + +- *Type:* TeamSettingsReviewRequestDelegation + +--- + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetNotify` + +```java +public void resetNotify() +``` + +##### `resetReviewRequestDelegation` + +```java +public void resetReviewRequestDelegation() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a TeamSettings resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.team_settings.TeamSettings; + +TeamSettings.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` + +```java +import io.cdktn.providers.github.team_settings.TeamSettings; + +TeamSettings.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.team_settings.TeamSettings; + +TeamSettings.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.team_settings.TeamSettings; + +TeamSettings.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),TeamSettings.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a TeamSettings 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 TeamSettings to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing TeamSettings that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings#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 TeamSettings 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| reviewRequestDelegation | TeamSettingsReviewRequestDelegationOutputReference | *No description.* | +| teamSlug | java.lang.String | *No description.* | +| teamUid | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| notifyInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| reviewRequestDelegationInput | TeamSettingsReviewRequestDelegation | *No description.* | +| teamIdInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| notify | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| teamId | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `reviewRequestDelegation`Required + +```java +public TeamSettingsReviewRequestDelegationOutputReference getReviewRequestDelegation(); +``` + +- *Type:* TeamSettingsReviewRequestDelegationOutputReference + +--- + +##### `teamSlug`Required + +```java +public java.lang.String getTeamSlug(); +``` + +- *Type:* java.lang.String + +--- + +##### `teamUid`Required + +```java +public java.lang.String getTeamUid(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `notifyInput`Optional + +```java +public java.lang.Boolean|IResolvable getNotifyInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `reviewRequestDelegationInput`Optional + +```java +public TeamSettingsReviewRequestDelegation getReviewRequestDelegationInput(); +``` + +- *Type:* TeamSettingsReviewRequestDelegation + +--- + +##### `teamIdInput`Optional + +```java +public java.lang.String getTeamIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `notify`Required + +```java +public java.lang.Boolean|IResolvable getNotify(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `teamId`Required + +```java +public java.lang.String getTeamId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### TeamSettingsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.team_settings.TeamSettingsConfig; + +TeamSettingsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .teamId(java.lang.String) +// .id(java.lang.String) +// .notify(java.lang.Boolean|IResolvable) +// .reviewRequestDelegation(TeamSettingsReviewRequestDelegation) + .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 | *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 | *No description.* | +| teamId | java.lang.String | The GitHub team id or the GitHub team slug. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings#id TeamSettings#id}. | +| notify | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether to notify the entire team when at least one member is also assigned to the pull request. | +| reviewRequestDelegation | TeamSettingsReviewRequestDelegation | review_request_delegation block. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `teamId`Required + +```java +public java.lang.String getTeamId(); +``` + +- *Type:* java.lang.String + +The GitHub team id or the GitHub team slug. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings#team_id TeamSettings#team_id} + +--- + +##### `id`Optional + +```java +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/resources/team_settings#id TeamSettings#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. + +--- + +##### `notify`Optional + +```java +public java.lang.Boolean|IResolvable getNotify(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether to notify the entire team when at least one member is also assigned to the pull request. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings#notify TeamSettings#notify} + +--- + +##### `reviewRequestDelegation`Optional + +```java +public TeamSettingsReviewRequestDelegation getReviewRequestDelegation(); +``` + +- *Type:* TeamSettingsReviewRequestDelegation + +review_request_delegation block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings#review_request_delegation TeamSettings#review_request_delegation} + +--- + +### TeamSettingsReviewRequestDelegation + +#### Initializer + +```java +import io.cdktn.providers.github.team_settings.TeamSettingsReviewRequestDelegation; + +TeamSettingsReviewRequestDelegation.builder() +// .algorithm(java.lang.String) +// .memberCount(java.lang.Number) +// .notify(java.lang.Boolean|IResolvable) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| algorithm | java.lang.String | The algorithm to use when assigning pull requests to team members. Supported values are ROUND_ROBIN and LOAD_BALANCE. | +| memberCount | java.lang.Number | The number of team members to assign to a pull request. | +| notify | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | whether to notify the entire team when at least one member is also assigned to the pull request. | + +--- + +##### `algorithm`Optional + +```java +public java.lang.String getAlgorithm(); +``` + +- *Type:* java.lang.String + +The algorithm to use when assigning pull requests to team members. Supported values are ROUND_ROBIN and LOAD_BALANCE. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings#algorithm TeamSettings#algorithm} + +--- + +##### `memberCount`Optional + +```java +public java.lang.Number getMemberCount(); +``` + +- *Type:* java.lang.Number + +The number of team members to assign to a pull request. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings#member_count TeamSettings#member_count} + +--- + +##### `notify`Optional + +```java +public java.lang.Boolean|IResolvable getNotify(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +whether to notify the entire team when at least one member is also assigned to the pull request. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_settings#notify TeamSettings#notify} + +--- + +## Classes + +### TeamSettingsReviewRequestDelegationOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.team_settings.TeamSettingsReviewRequestDelegationOutputReference; + +new TeamSettingsReviewRequestDelegationOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| resetAlgorithm | *No description.* | +| resetMemberCount | *No description.* | +| resetNotify | *No description.* | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `resetAlgorithm` + +```java +public void resetAlgorithm() +``` + +##### `resetMemberCount` + +```java +public void resetMemberCount() +``` + +##### `resetNotify` + +```java +public void resetNotify() +``` + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| algorithmInput | java.lang.String | *No description.* | +| memberCountInput | java.lang.Number | *No description.* | +| notifyInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| algorithm | java.lang.String | *No description.* | +| memberCount | java.lang.Number | *No description.* | +| notify | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| internalValue | TeamSettingsReviewRequestDelegation | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `algorithmInput`Optional + +```java +public java.lang.String getAlgorithmInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `memberCountInput`Optional + +```java +public java.lang.Number getMemberCountInput(); +``` + +- *Type:* java.lang.Number + +--- + +##### `notifyInput`Optional + +```java +public java.lang.Boolean|IResolvable getNotifyInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `algorithm`Required + +```java +public java.lang.String getAlgorithm(); +``` + +- *Type:* java.lang.String + +--- + +##### `memberCount`Required + +```java +public java.lang.Number getMemberCount(); +``` + +- *Type:* java.lang.Number + +--- + +##### `notify`Required + +```java +public java.lang.Boolean|IResolvable getNotify(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `internalValue`Optional + +```java +public TeamSettingsReviewRequestDelegation getInternalValue(); +``` + +- *Type:* TeamSettingsReviewRequestDelegation + +--- + + + diff --git a/docs/teamSyncGroupMapping.csharp.md b/docs/teamSyncGroupMapping.csharp.md new file mode 100644 index 000000000..2ff226479 --- /dev/null +++ b/docs/teamSyncGroupMapping.csharp.md @@ -0,0 +1,1503 @@ +# `teamSyncGroupMapping` Submodule + +## Constructs + +### TeamSyncGroupMapping + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_sync_group_mapping github_team_sync_group_mapping}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new TeamSyncGroupMapping(Construct Scope, string Id, TeamSyncGroupMappingConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | TeamSyncGroupMappingConfig | *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:* TeamSyncGroupMappingConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| PutGroup | *No description.* | +| ResetGroup | *No description.* | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `PutGroup` + +```csharp +private void PutGroup(IResolvable|TeamSyncGroupMappingGroup[] Value) +``` + +###### `Value`Required + +- *Type:* Io.Cdktn.IResolvable|TeamSyncGroupMappingGroup[] + +--- + +##### `ResetGroup` + +```csharp +private void ResetGroup() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a TeamSyncGroupMapping resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +TeamSyncGroupMapping.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` + +```csharp +using Io.Cdktn.Providers.Github; + +TeamSyncGroupMapping.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +TeamSyncGroupMapping.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +TeamSyncGroupMapping.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a TeamSyncGroupMapping resource upon running "cdktn 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 TeamSyncGroupMapping to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing TeamSyncGroupMapping that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_sync_group_mapping#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the TeamSyncGroupMapping to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Etag | string | *No description.* | +| Group | TeamSyncGroupMappingGroupList | *No description.* | +| GroupInput | Io.Cdktn.IResolvable\|TeamSyncGroupMappingGroup[] | *No description.* | +| IdInput | string | *No description.* | +| TeamSlugInput | string | *No description.* | +| Id | string | *No description.* | +| TeamSlug | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `Group`Required + +```csharp +public TeamSyncGroupMappingGroupList Group { get; } +``` + +- *Type:* TeamSyncGroupMappingGroupList + +--- + +##### `GroupInput`Optional + +```csharp +public IResolvable|TeamSyncGroupMappingGroup[] GroupInput { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|TeamSyncGroupMappingGroup[] + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `TeamSlugInput`Optional + +```csharp +public string TeamSlugInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `TeamSlug`Required + +```csharp +public string TeamSlug { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### TeamSyncGroupMappingConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new TeamSyncGroupMappingConfig { + 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 TeamSlug, + IResolvable|TeamSyncGroupMappingGroup[] Group = null, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| TeamSlug | string | Slug of the team. | +| Group | Io.Cdktn.IResolvable\|TeamSyncGroupMappingGroup[] | group block. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_sync_group_mapping#id TeamSyncGroupMapping#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `TeamSlug`Required + +```csharp +public string TeamSlug { get; set; } +``` + +- *Type:* string + +Slug of the team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_sync_group_mapping#team_slug TeamSyncGroupMapping#team_slug} + +--- + +##### `Group`Optional + +```csharp +public IResolvable|TeamSyncGroupMappingGroup[] Group { get; set; } +``` + +- *Type:* Io.Cdktn.IResolvable|TeamSyncGroupMappingGroup[] + +group block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_sync_group_mapping#group TeamSyncGroupMapping#group} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_sync_group_mapping#id TeamSyncGroupMapping#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. + +--- + +### TeamSyncGroupMappingGroup + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new TeamSyncGroupMappingGroup { + string GroupDescription, + string GroupId, + string GroupName +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GroupDescription | string | The description of the IdP group. | +| GroupId | string | The ID of the IdP group. | +| GroupName | string | The name of the IdP group. | + +--- + +##### `GroupDescription`Required + +```csharp +public string GroupDescription { get; set; } +``` + +- *Type:* string + +The description of the IdP group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_sync_group_mapping#group_description TeamSyncGroupMapping#group_description} + +--- + +##### `GroupId`Required + +```csharp +public string GroupId { get; set; } +``` + +- *Type:* string + +The ID of the IdP group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_sync_group_mapping#group_id TeamSyncGroupMapping#group_id} + +--- + +##### `GroupName`Required + +```csharp +public string GroupName { get; set; } +``` + +- *Type:* string + +The name of the IdP group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_sync_group_mapping#group_name TeamSyncGroupMapping#group_name} + +--- + +## Classes + +### TeamSyncGroupMappingGroupList + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new TeamSyncGroupMappingGroupList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| WrapsSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `WrapsSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| AllWithMapKey | Creating an iterator for this complex list. | +| ComputeFqn | *No description.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | +| Get | *No description.* | + +--- + +##### `AllWithMapKey` + +```csharp +private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `MapKeyAttributeName`Required + +- *Type:* string + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `Get` + +```csharp +private TeamSyncGroupMappingGroupOutputReference Get(double Index) +``` + +###### `Index`Required + +- *Type:* double + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|TeamSyncGroupMappingGroup[] | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|TeamSyncGroupMappingGroup[] InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|TeamSyncGroupMappingGroup[] + +--- + + +### TeamSyncGroupMappingGroupOutputReference + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new TeamSyncGroupMappingGroupOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TerraformResource | Io.Cdktn.IInterpolatingParent | The parent resource. | +| TerraformAttribute | string | The attribute on the parent resource this class is referencing. | +| ComplexObjectIndex | double | the index of this item in the list. | +| ComplexObjectIsFromSet | bool | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `TerraformResource`Required + +- *Type:* Io.Cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `TerraformAttribute`Required + +- *Type:* string + +The attribute on the parent resource this class is referencing. + +--- + +##### `ComplexObjectIndex`Required + +- *Type:* double + +the index of this item in the list. + +--- + +##### `ComplexObjectIsFromSet`Required + +- *Type:* bool + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| ComputeFqn | *No description.* | +| 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.* | +| Resolve | Produce the Token's value at resolution time. | +| ToString | Return a string representation of this resolvable object. | + +--- + +##### `ComputeFqn` + +```csharp +private string ComputeFqn() +``` + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string Property) +``` + +###### `Property`Required + +- *Type:* string + +--- + +##### `Resolve` + +```csharp +private object Resolve(IResolveContext Context) +``` + +Produce the Token's value at resolution time. + +###### `Context`Required + +- *Type:* Io.Cdktn.IResolveContext + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CreationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| Fqn | string | *No description.* | +| GroupDescriptionInput | string | *No description.* | +| GroupIdInput | string | *No description.* | +| GroupNameInput | string | *No description.* | +| GroupDescription | string | *No description.* | +| GroupId | string | *No description.* | +| GroupName | string | *No description.* | +| InternalValue | Io.Cdktn.IResolvable\|TeamSyncGroupMappingGroup | *No description.* | + +--- + +##### `CreationStack`Required + +```csharp +public string[] CreationStack { get; } +``` + +- *Type:* string[] + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `GroupDescriptionInput`Optional + +```csharp +public string GroupDescriptionInput { get; } +``` + +- *Type:* string + +--- + +##### `GroupIdInput`Optional + +```csharp +public string GroupIdInput { get; } +``` + +- *Type:* string + +--- + +##### `GroupNameInput`Optional + +```csharp +public string GroupNameInput { get; } +``` + +- *Type:* string + +--- + +##### `GroupDescription`Required + +```csharp +public string GroupDescription { get; } +``` + +- *Type:* string + +--- + +##### `GroupId`Required + +```csharp +public string GroupId { get; } +``` + +- *Type:* string + +--- + +##### `GroupName`Required + +```csharp +public string GroupName { get; } +``` + +- *Type:* string + +--- + +##### `InternalValue`Optional + +```csharp +public IResolvable|TeamSyncGroupMappingGroup InternalValue { get; } +``` + +- *Type:* Io.Cdktn.IResolvable|TeamSyncGroupMappingGroup + +--- + + + diff --git a/docs/teamSyncGroupMapping.java.md b/docs/teamSyncGroupMapping.java.md new file mode 100644 index 000000000..457692351 --- /dev/null +++ b/docs/teamSyncGroupMapping.java.md @@ -0,0 +1,1592 @@ +# `teamSyncGroupMapping` Submodule + +## Constructs + +### TeamSyncGroupMapping + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_sync_group_mapping github_team_sync_group_mapping}. + +#### Initializers + +```java +import io.cdktn.providers.github.team_sync_group_mapping.TeamSyncGroupMapping; + +TeamSyncGroupMapping.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .teamSlug(java.lang.String) +// .group(IResolvable|java.util.List) +// .id(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 | *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 | *No description.* | +| teamSlug | java.lang.String | Slug of the team. | +| group | io.cdktn.cdktn.IResolvable\|java.util.List<TeamSyncGroupMappingGroup> | group block. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_sync_group_mapping#id TeamSyncGroupMapping#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `teamSlug`Required + +- *Type:* java.lang.String + +Slug of the team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_sync_group_mapping#team_slug TeamSyncGroupMapping#team_slug} + +--- + +##### `group`Optional + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<TeamSyncGroupMappingGroup> + +group block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_sync_group_mapping#group TeamSyncGroupMapping#group} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_sync_group_mapping#id TeamSyncGroupMapping#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| putGroup | *No description.* | +| resetGroup | *No description.* | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `putGroup` + +```java +public void putGroup(IResolvable|java.util.List value) +``` + +###### `value`Required + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<TeamSyncGroupMappingGroup> + +--- + +##### `resetGroup` + +```java +public void resetGroup() +``` + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a TeamSyncGroupMapping resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.team_sync_group_mapping.TeamSyncGroupMapping; + +TeamSyncGroupMapping.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` + +```java +import io.cdktn.providers.github.team_sync_group_mapping.TeamSyncGroupMapping; + +TeamSyncGroupMapping.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.team_sync_group_mapping.TeamSyncGroupMapping; + +TeamSyncGroupMapping.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.team_sync_group_mapping.TeamSyncGroupMapping; + +TeamSyncGroupMapping.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),TeamSyncGroupMapping.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a TeamSyncGroupMapping 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 TeamSyncGroupMapping to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing TeamSyncGroupMapping that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_sync_group_mapping#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 TeamSyncGroupMapping 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| etag | java.lang.String | *No description.* | +| group | TeamSyncGroupMappingGroupList | *No description.* | +| groupInput | io.cdktn.cdktn.IResolvable\|java.util.List<TeamSyncGroupMappingGroup> | *No description.* | +| idInput | java.lang.String | *No description.* | +| teamSlugInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| teamSlug | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `group`Required + +```java +public TeamSyncGroupMappingGroupList getGroup(); +``` + +- *Type:* TeamSyncGroupMappingGroupList + +--- + +##### `groupInput`Optional + +```java +public IResolvable|java.util.List getGroupInput(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<TeamSyncGroupMappingGroup> + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `teamSlugInput`Optional + +```java +public java.lang.String getTeamSlugInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `teamSlug`Required + +```java +public java.lang.String getTeamSlug(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### TeamSyncGroupMappingConfig + +#### Initializer + +```java +import io.cdktn.providers.github.team_sync_group_mapping.TeamSyncGroupMappingConfig; + +TeamSyncGroupMappingConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .teamSlug(java.lang.String) +// .group(IResolvable|java.util.List) +// .id(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 | *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 | *No description.* | +| teamSlug | java.lang.String | Slug of the team. | +| group | io.cdktn.cdktn.IResolvable\|java.util.List<TeamSyncGroupMappingGroup> | group block. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_sync_group_mapping#id TeamSyncGroupMapping#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `teamSlug`Required + +```java +public java.lang.String getTeamSlug(); +``` + +- *Type:* java.lang.String + +Slug of the team. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_sync_group_mapping#team_slug TeamSyncGroupMapping#team_slug} + +--- + +##### `group`Optional + +```java +public IResolvable|java.util.List getGroup(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<TeamSyncGroupMappingGroup> + +group block. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_sync_group_mapping#group TeamSyncGroupMapping#group} + +--- + +##### `id`Optional + +```java +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/resources/team_sync_group_mapping#id TeamSyncGroupMapping#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. + +--- + +### TeamSyncGroupMappingGroup + +#### Initializer + +```java +import io.cdktn.providers.github.team_sync_group_mapping.TeamSyncGroupMappingGroup; + +TeamSyncGroupMappingGroup.builder() + .groupDescription(java.lang.String) + .groupId(java.lang.String) + .groupName(java.lang.String) + .build(); +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| groupDescription | java.lang.String | The description of the IdP group. | +| groupId | java.lang.String | The ID of the IdP group. | +| groupName | java.lang.String | The name of the IdP group. | + +--- + +##### `groupDescription`Required + +```java +public java.lang.String getGroupDescription(); +``` + +- *Type:* java.lang.String + +The description of the IdP group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_sync_group_mapping#group_description TeamSyncGroupMapping#group_description} + +--- + +##### `groupId`Required + +```java +public java.lang.String getGroupId(); +``` + +- *Type:* java.lang.String + +The ID of the IdP group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_sync_group_mapping#group_id TeamSyncGroupMapping#group_id} + +--- + +##### `groupName`Required + +```java +public java.lang.String getGroupName(); +``` + +- *Type:* java.lang.String + +The name of the IdP group. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/team_sync_group_mapping#group_name TeamSyncGroupMapping#group_name} + +--- + +## Classes + +### TeamSyncGroupMappingGroupList + +#### Initializers + +```java +import io.cdktn.providers.github.team_sync_group_mapping.TeamSyncGroupMappingGroupList; + +new TeamSyncGroupMappingGroupList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| wrapsSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `wrapsSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| allWithMapKey | Creating an iterator for this complex list. | +| computeFqn | *No description.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | +| get | *No description.* | + +--- + +##### `allWithMapKey` + +```java +public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName) +``` + +Creating an iterator for this complex list. + +The list will be converted into a map with the mapKeyAttributeName as the key. + +###### `mapKeyAttributeName`Required + +- *Type:* java.lang.String + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + +##### `get` + +```java +public TeamSyncGroupMappingGroupOutputReference get(java.lang.Number index) +``` + +###### `index`Required + +- *Type:* java.lang.Number + +the index of the item to return. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|java.util.List<TeamSyncGroupMappingGroup> | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|java.util.List getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|java.util.List<TeamSyncGroupMappingGroup> + +--- + + +### TeamSyncGroupMappingGroupOutputReference + +#### Initializers + +```java +import io.cdktn.providers.github.team_sync_group_mapping.TeamSyncGroupMappingGroupOutputReference; + +new TeamSyncGroupMappingGroupOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| terraformResource | io.cdktn.cdktn.IInterpolatingParent | The parent resource. | +| terraformAttribute | java.lang.String | The attribute on the parent resource this class is referencing. | +| complexObjectIndex | java.lang.Number | the index of this item in the list. | +| complexObjectIsFromSet | java.lang.Boolean | whether the list is wrapping a set (will add tolist() to be able to access an item via an index). | + +--- + +##### `terraformResource`Required + +- *Type:* io.cdktn.cdktn.IInterpolatingParent + +The parent resource. + +--- + +##### `terraformAttribute`Required + +- *Type:* java.lang.String + +The attribute on the parent resource this class is referencing. + +--- + +##### `complexObjectIndex`Required + +- *Type:* java.lang.Number + +the index of this item in the list. + +--- + +##### `complexObjectIsFromSet`Required + +- *Type:* java.lang.Boolean + +whether the list is wrapping a set (will add tolist() to be able to access an item via an index). + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| computeFqn | *No description.* | +| 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.* | +| resolve | Produce the Token's value at resolution time. | +| toString | Return a string representation of this resolvable object. | + +--- + +##### `computeFqn` + +```java +public java.lang.String computeFqn() +``` + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String property) +``` + +###### `property`Required + +- *Type:* java.lang.String + +--- + +##### `resolve` + +```java +public java.lang.Object resolve(IResolveContext _context) +``` + +Produce the Token's value at resolution time. + +###### `_context`Required + +- *Type:* io.cdktn.cdktn.IResolveContext + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Return a string representation of this resolvable object. + +Returns a reversible string representation. + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| creationStack | java.util.List | The creation stack of this resolvable which will be appended to errors thrown during resolution. | +| fqn | java.lang.String | *No description.* | +| groupDescriptionInput | java.lang.String | *No description.* | +| groupIdInput | java.lang.String | *No description.* | +| groupNameInput | java.lang.String | *No description.* | +| groupDescription | java.lang.String | *No description.* | +| groupId | java.lang.String | *No description.* | +| groupName | java.lang.String | *No description.* | +| internalValue | io.cdktn.cdktn.IResolvable\|TeamSyncGroupMappingGroup | *No description.* | + +--- + +##### `creationStack`Required + +```java +public java.util.List getCreationStack(); +``` + +- *Type:* java.util.List + +The creation stack of this resolvable which will be appended to errors thrown during resolution. + +If this returns an empty array the stack will not be attached. + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `groupDescriptionInput`Optional + +```java +public java.lang.String getGroupDescriptionInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `groupIdInput`Optional + +```java +public java.lang.String getGroupIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `groupNameInput`Optional + +```java +public java.lang.String getGroupNameInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `groupDescription`Required + +```java +public java.lang.String getGroupDescription(); +``` + +- *Type:* java.lang.String + +--- + +##### `groupId`Required + +```java +public java.lang.String getGroupId(); +``` + +- *Type:* java.lang.String + +--- + +##### `groupName`Required + +```java +public java.lang.String getGroupName(); +``` + +- *Type:* java.lang.String + +--- + +##### `internalValue`Optional + +```java +public IResolvable|TeamSyncGroupMappingGroup getInternalValue(); +``` + +- *Type:* io.cdktn.cdktn.IResolvable|TeamSyncGroupMappingGroup + +--- + + + diff --git a/docs/userGpgKey.csharp.md b/docs/userGpgKey.csharp.md new file mode 100644 index 000000000..132598308 --- /dev/null +++ b/docs/userGpgKey.csharp.md @@ -0,0 +1,896 @@ +# `userGpgKey` Submodule + +## Constructs + +### UserGpgKey + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_gpg_key github_user_gpg_key}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new UserGpgKey(Construct Scope, string Id, UserGpgKeyConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | UserGpgKeyConfig | *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:* UserGpgKeyConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a UserGpgKey resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +UserGpgKey.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` + +```csharp +using Io.Cdktn.Providers.Github; + +UserGpgKey.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +UserGpgKey.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +UserGpgKey.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a UserGpgKey resource upon running "cdktn 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 UserGpgKey to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing UserGpgKey that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_gpg_key#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the UserGpgKey to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Etag | string | *No description.* | +| KeyId | string | *No description.* | +| ArmoredPublicKeyInput | string | *No description.* | +| IdInput | string | *No description.* | +| ArmoredPublicKey | string | *No description.* | +| Id | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `KeyId`Required + +```csharp +public string KeyId { get; } +``` + +- *Type:* string + +--- + +##### `ArmoredPublicKeyInput`Optional + +```csharp +public string ArmoredPublicKeyInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `ArmoredPublicKey`Required + +```csharp +public string ArmoredPublicKey { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### UserGpgKeyConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new UserGpgKeyConfig { + 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 ArmoredPublicKey, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| ArmoredPublicKey | string | Your public GPG key, generated in ASCII-armored format. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_gpg_key#id UserGpgKey#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `ArmoredPublicKey`Required + +```csharp +public string ArmoredPublicKey { get; set; } +``` + +- *Type:* string + +Your public GPG key, generated in ASCII-armored format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_gpg_key#armored_public_key UserGpgKey#armored_public_key} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_gpg_key#id UserGpgKey#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. + +--- + + + diff --git a/docs/userGpgKey.java.md b/docs/userGpgKey.java.md new file mode 100644 index 000000000..7ede87bd2 --- /dev/null +++ b/docs/userGpgKey.java.md @@ -0,0 +1,973 @@ +# `userGpgKey` Submodule + +## Constructs + +### UserGpgKey + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_gpg_key github_user_gpg_key}. + +#### Initializers + +```java +import io.cdktn.providers.github.user_gpg_key.UserGpgKey; + +UserGpgKey.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .armoredPublicKey(java.lang.String) +// .id(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 | *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 | *No description.* | +| armoredPublicKey | java.lang.String | Your public GPG key, generated in ASCII-armored format. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_gpg_key#id UserGpgKey#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `armoredPublicKey`Required + +- *Type:* java.lang.String + +Your public GPG key, generated in ASCII-armored format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_gpg_key#armored_public_key UserGpgKey#armored_public_key} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_gpg_key#id UserGpgKey#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a UserGpgKey resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.user_gpg_key.UserGpgKey; + +UserGpgKey.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` + +```java +import io.cdktn.providers.github.user_gpg_key.UserGpgKey; + +UserGpgKey.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.user_gpg_key.UserGpgKey; + +UserGpgKey.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.user_gpg_key.UserGpgKey; + +UserGpgKey.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),UserGpgKey.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a UserGpgKey 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 UserGpgKey to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing UserGpgKey that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_gpg_key#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 UserGpgKey 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| etag | java.lang.String | *No description.* | +| keyId | java.lang.String | *No description.* | +| armoredPublicKeyInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| armoredPublicKey | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `keyId`Required + +```java +public java.lang.String getKeyId(); +``` + +- *Type:* java.lang.String + +--- + +##### `armoredPublicKeyInput`Optional + +```java +public java.lang.String getArmoredPublicKeyInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `armoredPublicKey`Required + +```java +public java.lang.String getArmoredPublicKey(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### UserGpgKeyConfig + +#### Initializer + +```java +import io.cdktn.providers.github.user_gpg_key.UserGpgKeyConfig; + +UserGpgKeyConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .armoredPublicKey(java.lang.String) +// .id(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 | *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 | *No description.* | +| armoredPublicKey | java.lang.String | Your public GPG key, generated in ASCII-armored format. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_gpg_key#id UserGpgKey#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `armoredPublicKey`Required + +```java +public java.lang.String getArmoredPublicKey(); +``` + +- *Type:* java.lang.String + +Your public GPG key, generated in ASCII-armored format. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_gpg_key#armored_public_key UserGpgKey#armored_public_key} + +--- + +##### `id`Optional + +```java +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/resources/user_gpg_key#id UserGpgKey#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. + +--- + + + diff --git a/docs/userInvitationAccepter.csharp.md b/docs/userInvitationAccepter.csharp.md new file mode 100644 index 000000000..b8604a891 --- /dev/null +++ b/docs/userInvitationAccepter.csharp.md @@ -0,0 +1,928 @@ +# `userInvitationAccepter` Submodule + +## Constructs + +### UserInvitationAccepter + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_invitation_accepter github_user_invitation_accepter}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new UserInvitationAccepter(Construct Scope, string Id, UserInvitationAccepterConfig Config = null); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | UserInvitationAccepterConfig | *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`Optional + +- *Type:* UserInvitationAccepterConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetAllowEmptyId | *No description.* | +| ResetId | *No description.* | +| ResetInvitationId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetAllowEmptyId` + +```csharp +private void ResetAllowEmptyId() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +##### `ResetInvitationId` + +```csharp +private void ResetInvitationId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a UserInvitationAccepter resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +UserInvitationAccepter.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` + +```csharp +using Io.Cdktn.Providers.Github; + +UserInvitationAccepter.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +UserInvitationAccepter.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +UserInvitationAccepter.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a UserInvitationAccepter resource upon running "cdktn 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 UserInvitationAccepter to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing UserInvitationAccepter that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_invitation_accepter#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the UserInvitationAccepter to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| AllowEmptyIdInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| IdInput | string | *No description.* | +| InvitationIdInput | string | *No description.* | +| AllowEmptyId | bool\|Io.Cdktn.IResolvable | *No description.* | +| Id | string | *No description.* | +| InvitationId | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `AllowEmptyIdInput`Optional + +```csharp +public bool|IResolvable AllowEmptyIdInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `InvitationIdInput`Optional + +```csharp +public string InvitationIdInput { get; } +``` + +- *Type:* string + +--- + +##### `AllowEmptyId`Required + +```csharp +public bool|IResolvable AllowEmptyId { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `InvitationId`Required + +```csharp +public string InvitationId { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### UserInvitationAccepterConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new UserInvitationAccepterConfig { + 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, + bool|IResolvable AllowEmptyId = null, + string Id = null, + string InvitationId = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| AllowEmptyId | bool\|Io.Cdktn.IResolvable | Allow the ID to be unset. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_invitation_accepter#id UserInvitationAccepter#id}. | +| InvitationId | string | ID of the invitation to accept. Must be set when 'allow_empty_id' is 'false'. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `AllowEmptyId`Optional + +```csharp +public bool|IResolvable AllowEmptyId { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Allow the ID to be unset. + +This will result in the resource being skipped when the ID is not set instead of returning an error. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_invitation_accepter#allow_empty_id UserInvitationAccepter#allow_empty_id} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_invitation_accepter#id UserInvitationAccepter#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. + +--- + +##### `InvitationId`Optional + +```csharp +public string InvitationId { get; set; } +``` + +- *Type:* string + +ID of the invitation to accept. Must be set when 'allow_empty_id' is 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_invitation_accepter#invitation_id UserInvitationAccepter#invitation_id} + +--- + + + diff --git a/docs/userInvitationAccepter.java.md b/docs/userInvitationAccepter.java.md new file mode 100644 index 000000000..6d09b0f4a --- /dev/null +++ b/docs/userInvitationAccepter.java.md @@ -0,0 +1,1019 @@ +# `userInvitationAccepter` Submodule + +## Constructs + +### UserInvitationAccepter + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_invitation_accepter github_user_invitation_accepter}. + +#### Initializers + +```java +import io.cdktn.providers.github.user_invitation_accepter.UserInvitationAccepter; + +UserInvitationAccepter.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .allowEmptyId(java.lang.Boolean|IResolvable) +// .id(java.lang.String) +// .invitationId(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 | *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 | *No description.* | +| allowEmptyId | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Allow the ID to be unset. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_invitation_accepter#id UserInvitationAccepter#id}. | +| invitationId | java.lang.String | ID of the invitation to accept. Must be set when 'allow_empty_id' is 'false'. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `allowEmptyId`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Allow the ID to be unset. + +This will result in the resource being skipped when the ID is not set instead of returning an error. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_invitation_accepter#allow_empty_id UserInvitationAccepter#allow_empty_id} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_invitation_accepter#id UserInvitationAccepter#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. + +--- + +##### `invitationId`Optional + +- *Type:* java.lang.String + +ID of the invitation to accept. Must be set when 'allow_empty_id' is 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_invitation_accepter#invitation_id UserInvitationAccepter#invitation_id} + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetAllowEmptyId | *No description.* | +| resetId | *No description.* | +| resetInvitationId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetAllowEmptyId` + +```java +public void resetAllowEmptyId() +``` + +##### `resetId` + +```java +public void resetId() +``` + +##### `resetInvitationId` + +```java +public void resetInvitationId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a UserInvitationAccepter resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.user_invitation_accepter.UserInvitationAccepter; + +UserInvitationAccepter.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` + +```java +import io.cdktn.providers.github.user_invitation_accepter.UserInvitationAccepter; + +UserInvitationAccepter.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.user_invitation_accepter.UserInvitationAccepter; + +UserInvitationAccepter.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.user_invitation_accepter.UserInvitationAccepter; + +UserInvitationAccepter.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),UserInvitationAccepter.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a UserInvitationAccepter 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 UserInvitationAccepter to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing UserInvitationAccepter that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_invitation_accepter#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 UserInvitationAccepter 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| allowEmptyIdInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| idInput | java.lang.String | *No description.* | +| invitationIdInput | java.lang.String | *No description.* | +| allowEmptyId | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| id | java.lang.String | *No description.* | +| invitationId | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `allowEmptyIdInput`Optional + +```java +public java.lang.Boolean|IResolvable getAllowEmptyIdInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `invitationIdInput`Optional + +```java +public java.lang.String getInvitationIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `allowEmptyId`Required + +```java +public java.lang.Boolean|IResolvable getAllowEmptyId(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `invitationId`Required + +```java +public java.lang.String getInvitationId(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### UserInvitationAccepterConfig + +#### Initializer + +```java +import io.cdktn.providers.github.user_invitation_accepter.UserInvitationAccepterConfig; + +UserInvitationAccepterConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) +// .allowEmptyId(java.lang.Boolean|IResolvable) +// .id(java.lang.String) +// .invitationId(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 | *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 | *No description.* | +| allowEmptyId | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Allow the ID to be unset. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_invitation_accepter#id UserInvitationAccepter#id}. | +| invitationId | java.lang.String | ID of the invitation to accept. Must be set when 'allow_empty_id' is 'false'. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `allowEmptyId`Optional + +```java +public java.lang.Boolean|IResolvable getAllowEmptyId(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Allow the ID to be unset. + +This will result in the resource being skipped when the ID is not set instead of returning an error. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_invitation_accepter#allow_empty_id UserInvitationAccepter#allow_empty_id} + +--- + +##### `id`Optional + +```java +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/resources/user_invitation_accepter#id UserInvitationAccepter#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. + +--- + +##### `invitationId`Optional + +```java +public java.lang.String getInvitationId(); +``` + +- *Type:* java.lang.String + +ID of the invitation to accept. Must be set when 'allow_empty_id' is 'false'. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_invitation_accepter#invitation_id UserInvitationAccepter#invitation_id} + +--- + + + diff --git a/docs/userSshKey.csharp.md b/docs/userSshKey.csharp.md new file mode 100644 index 000000000..c2c90108c --- /dev/null +++ b/docs/userSshKey.csharp.md @@ -0,0 +1,934 @@ +# `userSshKey` Submodule + +## Constructs + +### UserSshKey + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_ssh_key github_user_ssh_key}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new UserSshKey(Construct Scope, string Id, UserSshKeyConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | UserSshKeyConfig | *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:* UserSshKeyConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a UserSshKey resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +UserSshKey.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` + +```csharp +using Io.Cdktn.Providers.Github; + +UserSshKey.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +UserSshKey.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +UserSshKey.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a UserSshKey resource upon running "cdktn 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 UserSshKey to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing UserSshKey that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_ssh_key#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the UserSshKey to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Etag | string | *No description.* | +| Url | string | *No description.* | +| IdInput | string | *No description.* | +| KeyInput | string | *No description.* | +| TitleInput | string | *No description.* | +| Id | string | *No description.* | +| Key | string | *No description.* | +| Title | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Etag`Required + +```csharp +public string Etag { get; } +``` + +- *Type:* string + +--- + +##### `Url`Required + +```csharp +public string Url { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `KeyInput`Optional + +```csharp +public string KeyInput { get; } +``` + +- *Type:* string + +--- + +##### `TitleInput`Optional + +```csharp +public string TitleInput { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Key`Required + +```csharp +public string Key { get; } +``` + +- *Type:* string + +--- + +##### `Title`Required + +```csharp +public string Title { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### UserSshKeyConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new UserSshKeyConfig { + 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 Key, + string Title, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Key | string | The public SSH key to add to your GitHub account. | +| Title | string | A descriptive name for the new key. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_ssh_key#id UserSshKey#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Key`Required + +```csharp +public string Key { get; set; } +``` + +- *Type:* string + +The public SSH key to add to your GitHub account. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_ssh_key#key UserSshKey#key} + +--- + +##### `Title`Required + +```csharp +public string Title { get; set; } +``` + +- *Type:* string + +A descriptive name for the new key. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_ssh_key#title UserSshKey#title} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_ssh_key#id UserSshKey#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. + +--- + + + diff --git a/docs/userSshKey.java.md b/docs/userSshKey.java.md new file mode 100644 index 000000000..45865aedb --- /dev/null +++ b/docs/userSshKey.java.md @@ -0,0 +1,1023 @@ +# `userSshKey` Submodule + +## Constructs + +### UserSshKey + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_ssh_key github_user_ssh_key}. + +#### Initializers + +```java +import io.cdktn.providers.github.user_ssh_key.UserSshKey; + +UserSshKey.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .key(java.lang.String) + .title(java.lang.String) +// .id(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 | *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 | *No description.* | +| key | java.lang.String | The public SSH key to add to your GitHub account. | +| title | java.lang.String | A descriptive name for the new key. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_ssh_key#id UserSshKey#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `key`Required + +- *Type:* java.lang.String + +The public SSH key to add to your GitHub account. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_ssh_key#key UserSshKey#key} + +--- + +##### `title`Required + +- *Type:* java.lang.String + +A descriptive name for the new key. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_ssh_key#title UserSshKey#title} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_ssh_key#id UserSshKey#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a UserSshKey resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.user_ssh_key.UserSshKey; + +UserSshKey.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` + +```java +import io.cdktn.providers.github.user_ssh_key.UserSshKey; + +UserSshKey.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.user_ssh_key.UserSshKey; + +UserSshKey.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.user_ssh_key.UserSshKey; + +UserSshKey.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),UserSshKey.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a UserSshKey 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 UserSshKey to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing UserSshKey that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_ssh_key#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 UserSshKey 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| etag | java.lang.String | *No description.* | +| url | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| keyInput | java.lang.String | *No description.* | +| titleInput | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| key | java.lang.String | *No description.* | +| title | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `etag`Required + +```java +public java.lang.String getEtag(); +``` + +- *Type:* java.lang.String + +--- + +##### `url`Required + +```java +public java.lang.String getUrl(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `keyInput`Optional + +```java +public java.lang.String getKeyInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `titleInput`Optional + +```java +public java.lang.String getTitleInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `key`Required + +```java +public java.lang.String getKey(); +``` + +- *Type:* java.lang.String + +--- + +##### `title`Required + +```java +public java.lang.String getTitle(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### UserSshKeyConfig + +#### Initializer + +```java +import io.cdktn.providers.github.user_ssh_key.UserSshKeyConfig; + +UserSshKeyConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .key(java.lang.String) + .title(java.lang.String) +// .id(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 | *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 | *No description.* | +| key | java.lang.String | The public SSH key to add to your GitHub account. | +| title | java.lang.String | A descriptive name for the new key. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_ssh_key#id UserSshKey#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `key`Required + +```java +public java.lang.String getKey(); +``` + +- *Type:* java.lang.String + +The public SSH key to add to your GitHub account. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_ssh_key#key UserSshKey#key} + +--- + +##### `title`Required + +```java +public java.lang.String getTitle(); +``` + +- *Type:* java.lang.String + +A descriptive name for the new key. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/user_ssh_key#title UserSshKey#title} + +--- + +##### `id`Optional + +```java +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/resources/user_ssh_key#id UserSshKey#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. + +--- + + + diff --git a/docs/workflowRepositoryPermissions.csharp.md b/docs/workflowRepositoryPermissions.csharp.md new file mode 100644 index 000000000..1b920316e --- /dev/null +++ b/docs/workflowRepositoryPermissions.csharp.md @@ -0,0 +1,964 @@ +# `workflowRepositoryPermissions` Submodule + +## Constructs + +### WorkflowRepositoryPermissions + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/workflow_repository_permissions github_workflow_repository_permissions}. + +#### Initializers + +```csharp +using Io.Cdktn.Providers.Github; + +new WorkflowRepositoryPermissions(Construct Scope, string Id, WorkflowRepositoryPermissionsConfig Config); +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Scope | Constructs.Construct | The scope in which to define this construct. | +| Id | string | The scoped construct ID. | +| Config | WorkflowRepositoryPermissionsConfig | *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:* WorkflowRepositoryPermissionsConfig + +--- + +#### 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 | *No description.* | +| ToMetadata | *No description.* | +| ToTerraform | Adds this resource to the terraform JSON output. | +| AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| HasResourceMove | *No description.* | +| ImportFrom | *No description.* | +| InterpolationForAttribute | *No description.* | +| MoveFromId | Move the resource corresponding to "id" to this resource. | +| MoveTo | Moves this resource to the target resource given by moveTarget. | +| MoveToId | Moves this resource to the resource corresponding to "id". | +| ResetCanApprovePullRequestReviews | *No description.* | +| ResetDefaultWorkflowPermissions | *No description.* | +| ResetId | *No description.* | + +--- + +##### `ToString` + +```csharp +private string ToString() +``` + +Returns a string representation of this construct. + +##### `With` + +```csharp +private IConstruct With(params 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:* params Constructs.IMixin[] + +The mixins to apply. + +--- + +##### `AddOverride` + +```csharp +private void AddOverride(string Path, object Value) +``` + +###### `Path`Required + +- *Type:* string + +--- + +###### `Value`Required + +- *Type:* object + +--- + +##### `OverrideLogicalId` + +```csharp +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` + +```csharp +private void ResetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `ToHclTerraform` + +```csharp +private object ToHclTerraform() +``` + +##### `ToMetadata` + +```csharp +private object ToMetadata() +``` + +##### `ToTerraform` + +```csharp +private object ToTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `AddMoveTarget` + +```csharp +private void AddMoveTarget(string MoveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `MoveTarget`Required + +- *Type:* string + +The string move target that will correspond to this resource. + +--- + +##### `GetAnyMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetAnyMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanAttribute` + +```csharp +private IResolvable GetBooleanAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetBooleanMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetBooleanMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetListAttribute` + +```csharp +private string[] GetListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberAttribute` + +```csharp +private double GetNumberAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberListAttribute` + +```csharp +private double[] GetNumberListAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetNumberMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetNumberMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringAttribute` + +```csharp +private string GetStringAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `GetStringMapAttribute` + +```csharp +private System.Collections.Generic.IDictionary GetStringMapAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `HasResourceMove` + +```csharp +private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove() +``` + +##### `ImportFrom` + +```csharp +private void ImportFrom(string Id, TerraformProvider Provider = null) +``` + +###### `Id`Required + +- *Type:* string + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `InterpolationForAttribute` + +```csharp +private IResolvable InterpolationForAttribute(string TerraformAttribute) +``` + +###### `TerraformAttribute`Required + +- *Type:* string + +--- + +##### `MoveFromId` + +```csharp +private void MoveFromId(string Id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `Id`Required + +- *Type:* string + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `MoveTo` + +```csharp +private void MoveTo(string MoveTarget, string|double Index = null) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `MoveTarget`Required + +- *Type:* string + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `Index`Optional + +- *Type:* string|double + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `MoveToId` + +```csharp +private void MoveToId(string Id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `Id`Required + +- *Type:* string + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `ResetCanApprovePullRequestReviews` + +```csharp +private void ResetCanApprovePullRequestReviews() +``` + +##### `ResetDefaultWorkflowPermissions` + +```csharp +private void ResetDefaultWorkflowPermissions() +``` + +##### `ResetId` + +```csharp +private void ResetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| IsConstruct | Checks if `x` is a construct. | +| IsTerraformElement | *No description.* | +| IsTerraformResource | *No description.* | +| GenerateConfigForImport | Generates CDKTN code for importing a WorkflowRepositoryPermissions resource upon running "cdktn plan ". | + +--- + +##### `IsConstruct` + +```csharp +using Io.Cdktn.Providers.Github; + +WorkflowRepositoryPermissions.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` + +```csharp +using Io.Cdktn.Providers.Github; + +WorkflowRepositoryPermissions.IsTerraformElement(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `IsTerraformResource` + +```csharp +using Io.Cdktn.Providers.Github; + +WorkflowRepositoryPermissions.IsTerraformResource(object X); +``` + +###### `X`Required + +- *Type:* object + +--- + +##### `GenerateConfigForImport` + +```csharp +using Io.Cdktn.Providers.Github; + +WorkflowRepositoryPermissions.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null); +``` + +Generates CDKTN code for importing a WorkflowRepositoryPermissions resource upon running "cdktn 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 WorkflowRepositoryPermissions to import. + +--- + +###### `ImportFromId`Required + +- *Type:* string + +The id of the existing WorkflowRepositoryPermissions that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/workflow_repository_permissions#import import section} in the documentation of this resource for the id to use + +--- + +###### `Provider`Optional + +- *Type:* Io.Cdktn.TerraformProvider + +? Optional instance of the provider where the WorkflowRepositoryPermissions to import is found. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Node | Constructs.Node | The tree node. | +| CdktfStack | Io.Cdktn.TerraformStack | *No description.* | +| Fqn | string | *No description.* | +| FriendlyUniqueId | string | *No description.* | +| TerraformMetaArguments | System.Collections.Generic.IDictionary | *No description.* | +| TerraformResourceType | string | *No description.* | +| TerraformGeneratorMetadata | Io.Cdktn.TerraformProviderGeneratorMetadata | *No description.* | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | string[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| CanApprovePullRequestReviewsInput | bool\|Io.Cdktn.IResolvable | *No description.* | +| DefaultWorkflowPermissionsInput | string | *No description.* | +| IdInput | string | *No description.* | +| RepositoryInput | string | *No description.* | +| CanApprovePullRequestReviews | bool\|Io.Cdktn.IResolvable | *No description.* | +| DefaultWorkflowPermissions | string | *No description.* | +| Id | string | *No description.* | +| Repository | string | *No description.* | + +--- + +##### `Node`Required + +```csharp +public Node Node { get; } +``` + +- *Type:* Constructs.Node + +The tree node. + +--- + +##### `CdktfStack`Required + +```csharp +public TerraformStack CdktfStack { get; } +``` + +- *Type:* Io.Cdktn.TerraformStack + +--- + +##### `Fqn`Required + +```csharp +public string Fqn { get; } +``` + +- *Type:* string + +--- + +##### `FriendlyUniqueId`Required + +```csharp +public string FriendlyUniqueId { get; } +``` + +- *Type:* string + +--- + +##### `TerraformMetaArguments`Required + +```csharp +public System.Collections.Generic.IDictionary TerraformMetaArguments { get; } +``` + +- *Type:* System.Collections.Generic.IDictionary + +--- + +##### `TerraformResourceType`Required + +```csharp +public string TerraformResourceType { get; } +``` + +- *Type:* string + +--- + +##### `TerraformGeneratorMetadata`Optional + +```csharp +public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; } +``` + +- *Type:* Io.Cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public string[] DependsOn { get; } +``` + +- *Type:* string[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `CanApprovePullRequestReviewsInput`Optional + +```csharp +public bool|IResolvable CanApprovePullRequestReviewsInput { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `DefaultWorkflowPermissionsInput`Optional + +```csharp +public string DefaultWorkflowPermissionsInput { get; } +``` + +- *Type:* string + +--- + +##### `IdInput`Optional + +```csharp +public string IdInput { get; } +``` + +- *Type:* string + +--- + +##### `RepositoryInput`Optional + +```csharp +public string RepositoryInput { get; } +``` + +- *Type:* string + +--- + +##### `CanApprovePullRequestReviews`Required + +```csharp +public bool|IResolvable CanApprovePullRequestReviews { get; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +--- + +##### `DefaultWorkflowPermissions`Required + +```csharp +public string DefaultWorkflowPermissions { get; } +``` + +- *Type:* string + +--- + +##### `Id`Required + +```csharp +public string Id { get; } +``` + +- *Type:* string + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; } +``` + +- *Type:* string + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TfResourceType | string | *No description.* | + +--- + +##### `TfResourceType`Required + +```csharp +public string TfResourceType { get; } +``` + +- *Type:* string + +--- + +## Structs + +### WorkflowRepositoryPermissionsConfig + +#### Initializer + +```csharp +using Io.Cdktn.Providers.Github; + +new WorkflowRepositoryPermissionsConfig { + 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 Repository, + bool|IResolvable CanApprovePullRequestReviews = null, + string DefaultWorkflowPermissions = null, + string Id = null +}; +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Connection | Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection | *No description.* | +| Count | double\|Io.Cdktn.TerraformCount | *No description.* | +| DependsOn | Io.Cdktn.ITerraformDependable[] | *No description.* | +| ForEach | Io.Cdktn.ITerraformIterator | *No description.* | +| Lifecycle | Io.Cdktn.TerraformResourceLifecycle | *No description.* | +| Provider | Io.Cdktn.TerraformProvider | *No description.* | +| Provisioners | Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[] | *No description.* | +| Repository | string | The GitHub repository. | +| CanApprovePullRequestReviews | bool\|Io.Cdktn.IResolvable | Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. | +| DefaultWorkflowPermissions | string | The default workflow permissions granted to the GITHUB_TOKEN when running workflows. | +| Id | string | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/workflow_repository_permissions#id WorkflowRepositoryPermissions#id}. | + +--- + +##### `Connection`Optional + +```csharp +public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; } +``` + +- *Type:* Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection + +--- + +##### `Count`Optional + +```csharp +public double|TerraformCount Count { get; set; } +``` + +- *Type:* double|Io.Cdktn.TerraformCount + +--- + +##### `DependsOn`Optional + +```csharp +public ITerraformDependable[] DependsOn { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformDependable[] + +--- + +##### `ForEach`Optional + +```csharp +public ITerraformIterator ForEach { get; set; } +``` + +- *Type:* Io.Cdktn.ITerraformIterator + +--- + +##### `Lifecycle`Optional + +```csharp +public TerraformResourceLifecycle Lifecycle { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformResourceLifecycle + +--- + +##### `Provider`Optional + +```csharp +public TerraformProvider Provider { get; set; } +``` + +- *Type:* Io.Cdktn.TerraformProvider + +--- + +##### `Provisioners`Optional + +```csharp +public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; } +``` + +- *Type:* Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] + +--- + +##### `Repository`Required + +```csharp +public string Repository { get; set; } +``` + +- *Type:* string + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/workflow_repository_permissions#repository WorkflowRepositoryPermissions#repository} + +--- + +##### `CanApprovePullRequestReviews`Optional + +```csharp +public bool|IResolvable CanApprovePullRequestReviews { get; set; } +``` + +- *Type:* bool|Io.Cdktn.IResolvable + +Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/workflow_repository_permissions#can_approve_pull_request_reviews WorkflowRepositoryPermissions#can_approve_pull_request_reviews} + +--- + +##### `DefaultWorkflowPermissions`Optional + +```csharp +public string DefaultWorkflowPermissions { get; set; } +``` + +- *Type:* string + +The default workflow permissions granted to the GITHUB_TOKEN when running workflows. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/workflow_repository_permissions#default_workflow_permissions WorkflowRepositoryPermissions#default_workflow_permissions} + +--- + +##### `Id`Optional + +```csharp +public string Id { get; set; } +``` + +- *Type:* string + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/workflow_repository_permissions#id WorkflowRepositoryPermissions#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. + +--- + + + diff --git a/docs/workflowRepositoryPermissions.java.md b/docs/workflowRepositoryPermissions.java.md new file mode 100644 index 000000000..1328c9785 --- /dev/null +++ b/docs/workflowRepositoryPermissions.java.md @@ -0,0 +1,1065 @@ +# `workflowRepositoryPermissions` Submodule + +## Constructs + +### WorkflowRepositoryPermissions + +Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/workflow_repository_permissions github_workflow_repository_permissions}. + +#### Initializers + +```java +import io.cdktn.providers.github.workflow_repository_permissions.WorkflowRepositoryPermissions; + +WorkflowRepositoryPermissions.Builder.create(Construct scope, java.lang.String id) +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .canApprovePullRequestReviews(java.lang.Boolean|IResolvable) +// .defaultWorkflowPermissions(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | The GitHub repository. | +| canApprovePullRequestReviews | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. | +| defaultWorkflowPermissions | java.lang.String | The default workflow permissions granted to the GITHUB_TOKEN when running workflows. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/workflow_repository_permissions#id WorkflowRepositoryPermissions#id}. | + +--- + +##### `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 + +--- + +##### `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 + +--- + +##### `repository`Required + +- *Type:* java.lang.String + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/workflow_repository_permissions#repository WorkflowRepositoryPermissions#repository} + +--- + +##### `canApprovePullRequestReviews`Optional + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/workflow_repository_permissions#can_approve_pull_request_reviews WorkflowRepositoryPermissions#can_approve_pull_request_reviews} + +--- + +##### `defaultWorkflowPermissions`Optional + +- *Type:* java.lang.String + +The default workflow permissions granted to the GITHUB_TOKEN when running workflows. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/workflow_repository_permissions#default_workflow_permissions WorkflowRepositoryPermissions#default_workflow_permissions} + +--- + +##### `id`Optional + +- *Type:* java.lang.String + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/workflow_repository_permissions#id WorkflowRepositoryPermissions#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. + +--- + +#### 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 | *No description.* | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| 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.* | +| hasResourceMove | *No description.* | +| importFrom | *No description.* | +| interpolationForAttribute | *No description.* | +| moveFromId | Move the resource corresponding to "id" to this resource. | +| moveTo | Moves this resource to the target resource given by moveTarget. | +| moveToId | Moves this resource to the resource corresponding to "id". | +| resetCanApprovePullRequestReviews | *No description.* | +| resetDefaultWorkflowPermissions | *No description.* | +| resetId | *No description.* | + +--- + +##### `toString` + +```java +public java.lang.String toString() +``` + +Returns a string representation of this construct. + +##### `with` + +```java +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` + +```java +public void addOverride(java.lang.String path, java.lang.Object value) +``` + +###### `path`Required + +- *Type:* java.lang.String + +--- + +###### `value`Required + +- *Type:* java.lang.Object + +--- + +##### `overrideLogicalId` + +```java +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` + +```java +public void resetOverrideLogicalId() +``` + +Resets a previously passed logical Id to use the auto-generated logical id again. + +##### `toHclTerraform` + +```java +public java.lang.Object toHclTerraform() +``` + +##### `toMetadata` + +```java +public java.lang.Object toMetadata() +``` + +##### `toTerraform` + +```java +public java.lang.Object toTerraform() +``` + +Adds this resource to the terraform JSON output. + +##### `addMoveTarget` + +```java +public void addMoveTarget(java.lang.String moveTarget) +``` + +Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The string move target that will correspond to this resource. + +--- + +##### `getAnyMapAttribute` + +```java +public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanAttribute` + +```java +public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getBooleanMapAttribute` + +```java +public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getListAttribute` + +```java +public java.util.List getListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberAttribute` + +```java +public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberListAttribute` + +```java +public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getNumberMapAttribute` + +```java +public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringAttribute` + +```java +public java.lang.String getStringAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `getStringMapAttribute` + +```java +public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `hasResourceMove` + +```java +public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() +``` + +##### `importFrom` + +```java +public void importFrom(java.lang.String id) +public void importFrom(java.lang.String id, TerraformProvider provider) +``` + +###### `id`Required + +- *Type:* java.lang.String + +--- + +###### `provider`Optional + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `interpolationForAttribute` + +```java +public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) +``` + +###### `terraformAttribute`Required + +- *Type:* java.lang.String + +--- + +##### `moveFromId` + +```java +public void moveFromId(java.lang.String id) +``` + +Move the resource corresponding to "id" to this resource. + +Note that the resource being moved from must be marked as moved using it's instance function. + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource being moved from, e.g. "aws_s3_bucket.example". + +--- + +##### `moveTo` + +```java +public void moveTo(java.lang.String moveTarget) +public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index) +``` + +Moves this resource to the target resource given by moveTarget. + +###### `moveTarget`Required + +- *Type:* java.lang.String + +The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. + +--- + +###### `index`Optional + +- *Type:* java.lang.String|java.lang.Number + +Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. + +--- + +##### `moveToId` + +```java +public void moveToId(java.lang.String id) +``` + +Moves this resource to the resource corresponding to "id". + +###### `id`Required + +- *Type:* java.lang.String + +Full id of resource to move to, e.g. "aws_s3_bucket.example". + +--- + +##### `resetCanApprovePullRequestReviews` + +```java +public void resetCanApprovePullRequestReviews() +``` + +##### `resetDefaultWorkflowPermissions` + +```java +public void resetDefaultWorkflowPermissions() +``` + +##### `resetId` + +```java +public void resetId() +``` + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | +| isTerraformElement | *No description.* | +| isTerraformResource | *No description.* | +| generateConfigForImport | Generates CDKTN code for importing a WorkflowRepositoryPermissions resource upon running "cdktn plan ". | + +--- + +##### `isConstruct` + +```java +import io.cdktn.providers.github.workflow_repository_permissions.WorkflowRepositoryPermissions; + +WorkflowRepositoryPermissions.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` + +```java +import io.cdktn.providers.github.workflow_repository_permissions.WorkflowRepositoryPermissions; + +WorkflowRepositoryPermissions.isTerraformElement(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `isTerraformResource` + +```java +import io.cdktn.providers.github.workflow_repository_permissions.WorkflowRepositoryPermissions; + +WorkflowRepositoryPermissions.isTerraformResource(java.lang.Object x) +``` + +###### `x`Required + +- *Type:* java.lang.Object + +--- + +##### `generateConfigForImport` + +```java +import io.cdktn.providers.github.workflow_repository_permissions.WorkflowRepositoryPermissions; + +WorkflowRepositoryPermissions.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),WorkflowRepositoryPermissions.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider) +``` + +Generates CDKTN code for importing a WorkflowRepositoryPermissions 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 WorkflowRepositoryPermissions to import. + +--- + +###### `importFromId`Required + +- *Type:* java.lang.String + +The id of the existing WorkflowRepositoryPermissions that should be imported. + +Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/workflow_repository_permissions#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 WorkflowRepositoryPermissions 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 | *No description.* | +| terraformResourceType | java.lang.String | *No description.* | +| terraformGeneratorMetadata | io.cdktn.cdktn.TerraformProviderGeneratorMetadata | *No 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 | *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 | *No description.* | +| canApprovePullRequestReviewsInput | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| defaultWorkflowPermissionsInput | java.lang.String | *No description.* | +| idInput | java.lang.String | *No description.* | +| repositoryInput | java.lang.String | *No description.* | +| canApprovePullRequestReviews | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | *No description.* | +| defaultWorkflowPermissions | java.lang.String | *No description.* | +| id | java.lang.String | *No description.* | +| repository | java.lang.String | *No description.* | + +--- + +##### `node`Required + +```java +public Node getNode(); +``` + +- *Type:* software.constructs.Node + +The tree node. + +--- + +##### `cdktfStack`Required + +```java +public TerraformStack getCdktfStack(); +``` + +- *Type:* io.cdktn.cdktn.TerraformStack + +--- + +##### `fqn`Required + +```java +public java.lang.String getFqn(); +``` + +- *Type:* java.lang.String + +--- + +##### `friendlyUniqueId`Required + +```java +public java.lang.String getFriendlyUniqueId(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformMetaArguments`Required + +```java +public java.util.Map getTerraformMetaArguments(); +``` + +- *Type:* java.util.Map + +--- + +##### `terraformResourceType`Required + +```java +public java.lang.String getTerraformResourceType(); +``` + +- *Type:* java.lang.String + +--- + +##### `terraformGeneratorMetadata`Optional + +```java +public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProviderGeneratorMetadata + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `canApprovePullRequestReviewsInput`Optional + +```java +public java.lang.Boolean|IResolvable getCanApprovePullRequestReviewsInput(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `defaultWorkflowPermissionsInput`Optional + +```java +public java.lang.String getDefaultWorkflowPermissionsInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `idInput`Optional + +```java +public java.lang.String getIdInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `repositoryInput`Optional + +```java +public java.lang.String getRepositoryInput(); +``` + +- *Type:* java.lang.String + +--- + +##### `canApprovePullRequestReviews`Required + +```java +public java.lang.Boolean|IResolvable getCanApprovePullRequestReviews(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +--- + +##### `defaultWorkflowPermissions`Required + +```java +public java.lang.String getDefaultWorkflowPermissions(); +``` + +- *Type:* java.lang.String + +--- + +##### `id`Required + +```java +public java.lang.String getId(); +``` + +- *Type:* java.lang.String + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| tfResourceType | java.lang.String | *No description.* | + +--- + +##### `tfResourceType`Required + +```java +public java.lang.String getTfResourceType(); +``` + +- *Type:* java.lang.String + +--- + +## Structs + +### WorkflowRepositoryPermissionsConfig + +#### Initializer + +```java +import io.cdktn.providers.github.workflow_repository_permissions.WorkflowRepositoryPermissionsConfig; + +WorkflowRepositoryPermissionsConfig.builder() +// .connection(SSHProvisionerConnection|WinrmProvisionerConnection) +// .count(java.lang.Number|TerraformCount) +// .dependsOn(java.util.List) +// .forEach(ITerraformIterator) +// .lifecycle(TerraformResourceLifecycle) +// .provider(TerraformProvider) +// .provisioners(java.util.List) + .repository(java.lang.String) +// .canApprovePullRequestReviews(java.lang.Boolean|IResolvable) +// .defaultWorkflowPermissions(java.lang.String) +// .id(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 | *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 | *No description.* | +| repository | java.lang.String | The GitHub repository. | +| canApprovePullRequestReviews | java.lang.Boolean\|io.cdktn.cdktn.IResolvable | Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. | +| defaultWorkflowPermissions | java.lang.String | The default workflow permissions granted to the GITHUB_TOKEN when running workflows. | +| id | java.lang.String | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/workflow_repository_permissions#id WorkflowRepositoryPermissions#id}. | + +--- + +##### `connection`Optional + +```java +public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); +``` + +- *Type:* io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection + +--- + +##### `count`Optional + +```java +public java.lang.Number|TerraformCount getCount(); +``` + +- *Type:* java.lang.Number|io.cdktn.cdktn.TerraformCount + +--- + +##### `dependsOn`Optional + +```java +public java.util.List getDependsOn(); +``` + +- *Type:* java.util.List + +--- + +##### `forEach`Optional + +```java +public ITerraformIterator getForEach(); +``` + +- *Type:* io.cdktn.cdktn.ITerraformIterator + +--- + +##### `lifecycle`Optional + +```java +public TerraformResourceLifecycle getLifecycle(); +``` + +- *Type:* io.cdktn.cdktn.TerraformResourceLifecycle + +--- + +##### `provider`Optional + +```java +public TerraformProvider getProvider(); +``` + +- *Type:* io.cdktn.cdktn.TerraformProvider + +--- + +##### `provisioners`Optional + +```java +public java.util.List getProvisioners(); +``` + +- *Type:* java.util.List + +--- + +##### `repository`Required + +```java +public java.lang.String getRepository(); +``` + +- *Type:* java.lang.String + +The GitHub repository. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/workflow_repository_permissions#repository WorkflowRepositoryPermissions#repository} + +--- + +##### `canApprovePullRequestReviews`Optional + +```java +public java.lang.Boolean|IResolvable getCanApprovePullRequestReviews(); +``` + +- *Type:* java.lang.Boolean|io.cdktn.cdktn.IResolvable + +Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/workflow_repository_permissions#can_approve_pull_request_reviews WorkflowRepositoryPermissions#can_approve_pull_request_reviews} + +--- + +##### `defaultWorkflowPermissions`Optional + +```java +public java.lang.String getDefaultWorkflowPermissions(); +``` + +- *Type:* java.lang.String + +The default workflow permissions granted to the GITHUB_TOKEN when running workflows. + +Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/resources/workflow_repository_permissions#default_workflow_permissions WorkflowRepositoryPermissions#default_workflow_permissions} + +--- + +##### `id`Optional + +```java +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/resources/workflow_repository_permissions#id WorkflowRepositoryPermissions#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. + +--- + + +