`dataGitlabGroup` Submodule

Constructs

DataGitlabGroup

Represents a {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/data-sources/group gitlab_group}.

Initializers

import { dataGitlabGroup } from '@cdktf/provider-gitlab'

new dataGitlabGroup.DataGitlabGroup(scope: Construct, id: string, config?: DataGitlabGroupConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`DataGitlabGroupConfig`	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: DataGitlabGroupConfig

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`addOverride`	No description.
`overrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`resetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`toHclTerraform`	Adds this resource to the terraform JSON output.
`toMetadata`	No description.
`toTerraform`	Adds this resource to the terraform JSON output.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resetFullPath`	No description.
`resetGroupId`	No description.
`resetId`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`addOverride`

public addOverride(path: string, value: any): void

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

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`

public resetOverrideLogicalId(): void

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

`toHclTerraform`

public toHclTerraform(): any

Adds this resource to the terraform JSON output.

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`resetFullPath`

public resetFullPath(): void

`resetGroupId`

public resetGroupId(): void

`resetId`

public resetId(): void

Static Functions

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

`isConstruct`

import { dataGitlabGroup } from '@cdktf/provider-gitlab'

dataGitlabGroup.DataGitlabGroup.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.

`x`^Required

Type: any

Any object.

`isTerraformElement`

import { dataGitlabGroup } from '@cdktf/provider-gitlab'

dataGitlabGroup.DataGitlabGroup.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformDataSource`

import { dataGitlabGroup } from '@cdktf/provider-gitlab'

dataGitlabGroup.DataGitlabGroup.isTerraformDataSource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { dataGitlabGroup } from '@cdktf/provider-gitlab'

dataGitlabGroup.DataGitlabGroup.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a DataGitlabGroup resource upon running "cdktf plan ".

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: string

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

`importFromId`^Required

Type: string

The id of the existing DataGitlabGroup that should be imported.

Refer to the {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/data-sources/group#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: cdktf.TerraformProvider

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

Properties

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.
`defaultBranchProtection`	`number`	No description.
`description`	`string`	No description.
`extraSharedRunnersMinutesLimit`	`number`	No description.
`fullName`	`string`	No description.
`lfsEnabled`	`cdktf.IResolvable`	No description.
`membershipLock`	`cdktf.IResolvable`	No description.
`name`	`string`	No description.
`parentId`	`number`	No description.
`path`	`string`	No description.
`preventForkingOutsideGroup`	`cdktf.IResolvable`	No description.
`requestAccessEnabled`	`cdktf.IResolvable`	No description.
`runnersToken`	`string`	No description.
`sharedRunnersMinutesLimit`	`number`	No description.
`sharedRunnersSetting`	`string`	No description.
`sharedWithGroups`	`DataGitlabGroupSharedWithGroupsList`	No description.
`visibilityLevel`	`string`	No description.
`webUrl`	`string`	No description.
`wikiAccessLevel`	`string`	No description.
`fullPathInput`	`string`	No description.
`groupIdInput`	`number`	No description.
`idInput`	`string`	No description.
`fullPath`	`string`	No description.
`groupId`	`number`	No description.
`id`	`string`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktf.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktf.TerraformProviderGeneratorMetadata

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`defaultBranchProtection`^Required

public readonly defaultBranchProtection: number;

Type: number

`description`^Required

public readonly description: string;

Type: string

`extraSharedRunnersMinutesLimit`^Required

public readonly extraSharedRunnersMinutesLimit: number;

Type: number

`fullName`^Required

public readonly fullName: string;

Type: string

`lfsEnabled`^Required

public readonly lfsEnabled: IResolvable;

Type: cdktf.IResolvable

`membershipLock`^Required

public readonly membershipLock: IResolvable;

Type: cdktf.IResolvable

`name`^Required

public readonly name: string;

Type: string

`parentId`^Required

public readonly parentId: number;

Type: number

`path`^Required

public readonly path: string;

Type: string

`preventForkingOutsideGroup`^Required

public readonly preventForkingOutsideGroup: IResolvable;

Type: cdktf.IResolvable

`requestAccessEnabled`^Required

public readonly requestAccessEnabled: IResolvable;

Type: cdktf.IResolvable

`runnersToken`^Required

public readonly runnersToken: string;

Type: string

`sharedRunnersMinutesLimit`^Required

public readonly sharedRunnersMinutesLimit: number;

Type: number

`sharedRunnersSetting`^Required

public readonly sharedRunnersSetting: string;

Type: string

`sharedWithGroups`^Required

public readonly sharedWithGroups: DataGitlabGroupSharedWithGroupsList;

Type: DataGitlabGroupSharedWithGroupsList

`visibilityLevel`^Required

public readonly visibilityLevel: string;

Type: string

`webUrl`^Required

public readonly webUrl: string;

Type: string

`wikiAccessLevel`^Required

public readonly wikiAccessLevel: string;

Type: string

`fullPathInput`^Optional

public readonly fullPathInput: string;

Type: string

`groupIdInput`^Optional

public readonly groupIdInput: number;

Type: number

`idInput`^Optional

public readonly idInput: string;

Type: string

`fullPath`^Required

public readonly fullPath: string;

Type: string

`groupId`^Required

public readonly groupId: number;

Type: number

`id`^Required

public readonly id: string;

Type: string

Constants

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

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

DataGitlabGroupConfig

Initializer

import { dataGitlabGroup } from '@cdktf/provider-gitlab'

const dataGitlabGroupConfig: dataGitlabGroup.DataGitlabGroupConfig = { ... }

Properties

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.
`fullPath`	`string`	The full path of the group.
`groupId`	`number`	The ID of the group.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/data-sources/group#id DataGitlabGroup#id}.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktf.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`fullPath`^Optional

public readonly fullPath: string;

Type: string

The full path of the group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/data-sources/group#full_path DataGitlabGroup#full_path}

`groupId`^Optional

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#group_id DataGitlabGroup#group_id}

`id`^Optional

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#id DataGitlabGroup#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

DataGitlabGroupSharedWithGroups

Initializer

import { dataGitlabGroup } from '@cdktf/provider-gitlab'

const dataGitlabGroupSharedWithGroups: dataGitlabGroup.DataGitlabGroupSharedWithGroups = { ... }

Classes

DataGitlabGroupSharedWithGroupsList

Initializers

import { dataGitlabGroup } from '@cdktf/provider-gitlab'

new dataGitlabGroup.DataGitlabGroupSharedWithGroupsList(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).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`wrapsSet`^Required

Type: 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`

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.

`mapKeyAttributeName`^Required

Type: string

`computeFqn`

public computeFqn(): string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`get`

public get(index: number): DataGitlabGroupSharedWithGroupsOutputReference

`index`^Required

Type: number

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

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.

`fqn`^Required

public readonly fqn: string;

Type: string

DataGitlabGroupSharedWithGroupsOutputReference

Initializers

import { dataGitlabGroup } from '@cdktf/provider-gitlab'

new dataGitlabGroup.DataGitlabGroupSharedWithGroupsOutputReference(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).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`complexObjectIndex`^Required

Type: number

the index of this item in the list.

`complexObjectIsFromSet`^Required

Type: 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`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

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.
`expiresAt`	`string`	No description.
`groupAccessLevel`	`number`	No description.
`groupFullPath`	`string`	No description.
`groupId`	`number`	No description.
`groupName`	`string`	No description.
`internalValue`	`DataGitlabGroupSharedWithGroups`	No description.

`creationStack`^Required

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.

`fqn`^Required

public readonly fqn: string;

Type: string

`expiresAt`^Required

public readonly expiresAt: string;

Type: string

`groupAccessLevel`^Required

public readonly groupAccessLevel: number;

Type: number

`groupFullPath`^Required

public readonly groupFullPath: string;

Type: string

`groupId`^Required

public readonly groupId: number;

Type: number

`groupName`^Required

public readonly groupName: string;

Type: string

`internalValue`^Optional

public readonly internalValue: DataGitlabGroupSharedWithGroups;

Type: DataGitlabGroupSharedWithGroups

Files

dataGitlabGroup.typescript.md

Latest commit

History

dataGitlabGroup.typescript.md

File metadata and controls

dataGitlabGroup Submodule

Constructs