Represents a {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/data-sources/group_subgroups gitlab_group_subgroups}.
import { dataGitlabGroupSubgroups } from '@cdktf/provider-gitlab'
new dataGitlabGroupSubgroups.DataGitlabGroupSubgroups(scope: Construct, id: string, config: DataGitlabGroupSubgroupsConfig)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
string |
The scoped construct ID. |
config |
DataGitlabGroupSubgroupsConfig |
No description. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
Name | Description |
---|---|
toString |
Returns a string representation of this construct. |
addOverride |
No description. |
overrideLogicalId |
Overrides the auto-generated logical ID with a specific ID. |
resetOverrideLogicalId |
Resets a previously passed logical Id to use the auto-generated logical id again. |
toHclTerraform |
Adds this resource to the terraform JSON output. |
toMetadata |
No description. |
toTerraform |
Adds this resource to the terraform JSON output. |
getAnyMapAttribute |
No description. |
getBooleanAttribute |
No description. |
getBooleanMapAttribute |
No description. |
getListAttribute |
No description. |
getNumberAttribute |
No description. |
getNumberListAttribute |
No description. |
getNumberMapAttribute |
No description. |
getStringAttribute |
No description. |
getStringMapAttribute |
No description. |
interpolationForAttribute |
No description. |
resetAllAvailable |
No description. |
resetId |
No description. |
resetMinAccessLevel |
No description. |
resetOrderBy |
No description. |
resetOwned |
No description. |
resetSearch |
No description. |
resetSkipGroups |
No description. |
resetSort |
No description. |
resetStatistics |
No description. |
resetWithCustomAttributes |
No description. |
public toString(): string
Returns a string representation of this construct.
public addOverride(path: string, value: any): void
- Type: string
- Type: any
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
public toHclTerraform(): any
Adds this resource to the terraform JSON output.
public toMetadata(): any
public toTerraform(): any
Adds this resource to the terraform JSON output.
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public interpolationForAttribute(terraformAttribute: string): IResolvable
- Type: string
public resetAllAvailable(): void
public resetId(): void
public resetMinAccessLevel(): void
public resetOrderBy(): void
public resetOwned(): void
public resetSearch(): void
public resetSkipGroups(): void
public resetSort(): void
public resetStatistics(): void
public resetWithCustomAttributes(): void
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformDataSource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a DataGitlabGroupSubgroups resource upon running "cdktf plan ". |
import { dataGitlabGroupSubgroups } from '@cdktf/provider-gitlab'
dataGitlabGroupSubgroups.DataGitlabGroupSubgroups.isConstruct(x: any)
Checks if x
is a construct.
Use this method instead of instanceof
to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs
library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct
in each copy of the constructs
library
is seen as a different class, and an instance of one class will not test as
instanceof
the other class. npm install
will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof
will behave
unpredictably. It is safest to avoid using instanceof
, and using
this type-testing method instead.
- Type: any
Any object.
import { dataGitlabGroupSubgroups } from '@cdktf/provider-gitlab'
dataGitlabGroupSubgroups.DataGitlabGroupSubgroups.isTerraformElement(x: any)
- Type: any
import { dataGitlabGroupSubgroups } from '@cdktf/provider-gitlab'
dataGitlabGroupSubgroups.DataGitlabGroupSubgroups.isTerraformDataSource(x: any)
- Type: any
import { dataGitlabGroupSubgroups } from '@cdktf/provider-gitlab'
dataGitlabGroupSubgroups.DataGitlabGroupSubgroups.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)
Generates CDKTF code for importing a DataGitlabGroupSubgroups resource upon running "cdktf plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the DataGitlabGroupSubgroups to import.
- Type: string
The id of the existing DataGitlabGroupSubgroups that should be imported.
Refer to the {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/data-sources/group_subgroups#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the DataGitlabGroupSubgroups to import is found.
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
cdktfStack |
cdktf.TerraformStack |
No description. |
fqn |
string |
No description. |
friendlyUniqueId |
string |
No description. |
terraformMetaArguments |
{[ key: string ]: any} |
No description. |
terraformResourceType |
string |
No description. |
terraformGeneratorMetadata |
cdktf.TerraformProviderGeneratorMetadata |
No description. |
count |
number | cdktf.TerraformCount |
No description. |
dependsOn |
string[] |
No description. |
forEach |
cdktf.ITerraformIterator |
No description. |
lifecycle |
cdktf.TerraformResourceLifecycle |
No description. |
provider |
cdktf.TerraformProvider |
No description. |
subgroups |
DataGitlabGroupSubgroupsSubgroupsList |
No description. |
allAvailableInput |
boolean | cdktf.IResolvable |
No description. |
groupIdInput |
number |
No description. |
idInput |
string |
No description. |
minAccessLevelInput |
string |
No description. |
orderByInput |
string |
No description. |
ownedInput |
boolean | cdktf.IResolvable |
No description. |
searchInput |
string |
No description. |
skipGroupsInput |
number[] |
No description. |
sortInput |
string |
No description. |
statisticsInput |
boolean | cdktf.IResolvable |
No description. |
withCustomAttributesInput |
boolean | cdktf.IResolvable |
No description. |
allAvailable |
boolean | cdktf.IResolvable |
No description. |
groupId |
number |
No description. |
id |
string |
No description. |
minAccessLevel |
string |
No description. |
orderBy |
string |
No description. |
owned |
boolean | cdktf.IResolvable |
No description. |
search |
string |
No description. |
skipGroups |
number[] |
No description. |
sort |
string |
No description. |
statistics |
boolean | cdktf.IResolvable |
No description. |
withCustomAttributes |
boolean | cdktf.IResolvable |
No description. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly cdktfStack: TerraformStack;
- Type: cdktf.TerraformStack
public readonly fqn: string;
- Type: string
public readonly friendlyUniqueId: string;
- Type: string
public readonly terraformMetaArguments: {[ key: string ]: any};
- Type: {[ key: string ]: any}
public readonly terraformResourceType: string;
- Type: string
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
- Type: cdktf.TerraformProviderGeneratorMetadata
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: string[];
- Type: string[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly subgroups: DataGitlabGroupSubgroupsSubgroupsList;
public readonly allAvailableInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly groupIdInput: number;
- Type: number
public readonly idInput: string;
- Type: string
public readonly minAccessLevelInput: string;
- Type: string
public readonly orderByInput: string;
- Type: string
public readonly ownedInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly searchInput: string;
- Type: string
public readonly skipGroupsInput: number[];
- Type: number[]
public readonly sortInput: string;
- Type: string
public readonly statisticsInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly withCustomAttributesInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly allAvailable: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly groupId: number;
- Type: number
public readonly id: string;
- Type: string
public readonly minAccessLevel: string;
- Type: string
public readonly orderBy: string;
- Type: string
public readonly owned: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly search: string;
- Type: string
public readonly skipGroups: number[];
- Type: number[]
public readonly sort: string;
- Type: string
public readonly statistics: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly withCustomAttributes: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Name | Type | Description |
---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;
- Type: string
import { dataGitlabGroupSubgroups } from '@cdktf/provider-gitlab'
const dataGitlabGroupSubgroupsConfig: dataGitlabGroupSubgroups.DataGitlabGroupSubgroupsConfig = { ... }
Name | Type | Description |
---|---|---|
connection |
cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection |
No description. |
count |
number | cdktf.TerraformCount |
No description. |
dependsOn |
cdktf.ITerraformDependable[] |
No description. |
forEach |
cdktf.ITerraformIterator |
No description. |
lifecycle |
cdktf.TerraformResourceLifecycle |
No description. |
provider |
cdktf.TerraformProvider |
No description. |
provisioners |
cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] |
No description. |
groupId |
number |
The ID of the group. |
allAvailable |
boolean | cdktf.IResolvable |
Show all the groups you have access to. |
id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/data-sources/group_subgroups#id DataGitlabGroupSubgroups#id}. |
minAccessLevel |
string |
Limit to groups where current user has at least this access level. |
orderBy |
string |
Order groups by name, path or id. |
owned |
boolean | cdktf.IResolvable |
Limit to groups explicitly owned by the current user. |
search |
string |
Return the list of authorized groups matching the search criteria. |
skipGroups |
number[] |
Skip the group IDs passed. |
sort |
string |
Order groups in asc or desc order. |
statistics |
boolean | cdktf.IResolvable |
Include group statistics (administrators only). |
withCustomAttributes |
boolean | cdktf.IResolvable |
Include custom attributes in response (administrators only). |
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: ITerraformDependable[];
- Type: cdktf.ITerraformDependable[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly groupId: number;
- Type: number
The ID of the group.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/data-sources/group_subgroups#group_id DataGitlabGroupSubgroups#group_id}
public readonly allAvailable: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Show all the groups you have access to.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/data-sources/group_subgroups#all_available DataGitlabGroupSubgroups#all_available}
public readonly id: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/data-sources/group_subgroups#id DataGitlabGroupSubgroups#id}.
Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you 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 readonly minAccessLevel: string;
- Type: string
Limit to groups where current user has at least this access level.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/data-sources/group_subgroups#min_access_level DataGitlabGroupSubgroups#min_access_level}
public readonly orderBy: string;
- Type: string
Order groups by name, path or id.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/data-sources/group_subgroups#order_by DataGitlabGroupSubgroups#order_by}
public readonly owned: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Limit to groups explicitly owned by the current user.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/data-sources/group_subgroups#owned DataGitlabGroupSubgroups#owned}
public readonly search: string;
- Type: string
Return the list of authorized groups matching the search criteria.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/data-sources/group_subgroups#search DataGitlabGroupSubgroups#search}
public readonly skipGroups: number[];
- Type: number[]
Skip the group IDs passed.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/data-sources/group_subgroups#skip_groups DataGitlabGroupSubgroups#skip_groups}
public readonly sort: string;
- Type: string
Order groups in asc or desc order.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/data-sources/group_subgroups#sort DataGitlabGroupSubgroups#sort}
public readonly statistics: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Include group statistics (administrators only).
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/data-sources/group_subgroups#statistics DataGitlabGroupSubgroups#statistics}
public readonly withCustomAttributes: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Include custom attributes in response (administrators only).
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/data-sources/group_subgroups#with_custom_attributes DataGitlabGroupSubgroups#with_custom_attributes}
import { dataGitlabGroupSubgroups } from '@cdktf/provider-gitlab'
const dataGitlabGroupSubgroupsSubgroups: dataGitlabGroupSubgroups.DataGitlabGroupSubgroupsSubgroups = { ... }
import { dataGitlabGroupSubgroups } from '@cdktf/provider-gitlab'
new dataGitlabGroupSubgroups.DataGitlabGroupSubgroupsSubgroupsList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)
Name | Type | Description |
---|---|---|
terraformResource |
cdktf.IInterpolatingParent |
The parent resource. |
terraformAttribute |
string |
The attribute on the parent resource this class is referencing. |
wrapsSet |
boolean |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
- Type: boolean
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
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. |
public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator
Creating an iterator for this complex list.
The list will be converted into a map with the mapKeyAttributeName as the key.
- Type: string
public computeFqn(): string
public resolve(_context: IResolveContext): any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
public toString(): string
Return a string representation of this resolvable object.
Returns a reversible string representation.
public get(index: number): DataGitlabGroupSubgroupsSubgroupsOutputReference
- Type: number
the index of the item to return.
Name | Type | Description |
---|---|---|
creationStack |
string[] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
string |
No description. |
public readonly creationStack: string[];
- 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.
public readonly fqn: string;
- Type: string
import { dataGitlabGroupSubgroups } from '@cdktf/provider-gitlab'
new dataGitlabGroupSubgroups.DataGitlabGroupSubgroupsSubgroupsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)
Name | Type | Description |
---|---|---|
terraformResource |
cdktf.IInterpolatingParent |
The parent resource. |
terraformAttribute |
string |
The attribute on the parent resource this class is referencing. |
complexObjectIndex |
number |
the index of this item in the list. |
complexObjectIsFromSet |
boolean |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
- Type: number
the index of this item in the list.
- Type: boolean
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
Name | Description |
---|---|
computeFqn |
No description. |
getAnyMapAttribute |
No description. |
getBooleanAttribute |
No description. |
getBooleanMapAttribute |
No description. |
getListAttribute |
No description. |
getNumberAttribute |
No description. |
getNumberListAttribute |
No description. |
getNumberMapAttribute |
No description. |
getStringAttribute |
No description. |
getStringMapAttribute |
No description. |
interpolationForAttribute |
No description. |
resolve |
Produce the Token's value at resolution time. |
toString |
Return a string representation of this resolvable object. |
public computeFqn(): string
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public interpolationForAttribute(property: string): IResolvable
- Type: string
public resolve(_context: IResolveContext): any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
public toString(): string
Return a string representation of this resolvable object.
Returns a reversible string representation.
Name | Type | Description |
---|---|---|
creationStack |
string[] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
string |
No description. |
autoDevopsEnabled |
cdktf.IResolvable |
No description. |
avatarUrl |
string |
No description. |
createdAt |
string |
No description. |
defaultBranchProtection |
number |
No description. |
description |
string |
No description. |
emailsEnabled |
cdktf.IResolvable |
No description. |
fileTemplateProjectId |
number |
No description. |
fullName |
string |
No description. |
fullPath |
string |
No description. |
groupId |
number |
No description. |
ipRestrictionRanges |
string |
No description. |
lfsEnabled |
cdktf.IResolvable |
No description. |
mentionsDisabled |
cdktf.IResolvable |
No description. |
name |
string |
No description. |
parentId |
number |
No description. |
path |
string |
No description. |
projectCreationLevel |
string |
No description. |
requestAccessEnabled |
cdktf.IResolvable |
No description. |
requireTwoFactorAuthentication |
cdktf.IResolvable |
No description. |
sharedRunnersSetting |
string |
No description. |
shareWithGroupLock |
cdktf.IResolvable |
No description. |
statistics |
cdktf.StringMap |
No description. |
subgroupCreationLevel |
string |
No description. |
twoFactorGracePeriod |
number |
No description. |
visibility |
string |
No description. |
webUrl |
string |
No description. |
wikiAccessLevel |
string |
No description. |
internalValue |
DataGitlabGroupSubgroupsSubgroups |
No description. |
public readonly creationStack: string[];
- 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.
public readonly fqn: string;
- Type: string
public readonly autoDevopsEnabled: IResolvable;
- Type: cdktf.IResolvable
public readonly avatarUrl: string;
- Type: string
public readonly createdAt: string;
- Type: string
public readonly defaultBranchProtection: number;
- Type: number
public readonly description: string;
- Type: string
public readonly emailsEnabled: IResolvable;
- Type: cdktf.IResolvable
public readonly fileTemplateProjectId: number;
- Type: number
public readonly fullName: string;
- Type: string
public readonly fullPath: string;
- Type: string
public readonly groupId: number;
- Type: number
public readonly ipRestrictionRanges: string;
- Type: string
public readonly lfsEnabled: IResolvable;
- Type: cdktf.IResolvable
public readonly mentionsDisabled: IResolvable;
- Type: cdktf.IResolvable
public readonly name: string;
- Type: string
public readonly parentId: number;
- Type: number
public readonly path: string;
- Type: string
public readonly projectCreationLevel: string;
- Type: string
public readonly requestAccessEnabled: IResolvable;
- Type: cdktf.IResolvable
public readonly requireTwoFactorAuthentication: IResolvable;
- Type: cdktf.IResolvable
public readonly sharedRunnersSetting: string;
- Type: string
public readonly shareWithGroupLock: IResolvable;
- Type: cdktf.IResolvable
public readonly statistics: StringMap;
- Type: cdktf.StringMap
public readonly subgroupCreationLevel: string;
- Type: string
public readonly twoFactorGracePeriod: number;
- Type: number
public readonly visibility: string;
- Type: string
public readonly webUrl: string;
- Type: string
public readonly wikiAccessLevel: string;
- Type: string
public readonly internalValue: DataGitlabGroupSubgroupsSubgroups;