`dataGitlabGroup` Submodule

Constructs

DataGitlabGroup

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

Initializers

using HashiCorp.Cdktf.Providers.Gitlab;

new DataGitlabGroup(Construct Scope, string Id, DataGitlabGroupConfig Config = null);

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`

private string ToString()

Returns a string representation of this construct.

`AddOverride`

private void AddOverride(string Path, object Value)

`Path`^Required

Type: string

`Value`^Required

Type: object

`OverrideLogicalId`

private void OverrideLogicalId(string NewLogicalId)

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

`NewLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`ResetOverrideLogicalId`

private void ResetOverrideLogicalId()

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

`ToHclTerraform`

private object ToHclTerraform()

Adds this resource to the terraform JSON output.

`ToMetadata`

private object ToMetadata()

`ToTerraform`

private object ToTerraform()

Adds this resource to the terraform JSON output.

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`ResetFullPath`

private void ResetFullPath()

`ResetGroupId`

private void ResetGroupId()

`ResetId`

private void ResetId()

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`

using HashiCorp.Cdktf.Providers.Gitlab;

DataGitlabGroup.IsConstruct(object X);

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`X`^Required

Type: object

Any object.

`IsTerraformElement`

using HashiCorp.Cdktf.Providers.Gitlab;

DataGitlabGroup.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformDataSource`

using HashiCorp.Cdktf.Providers.Gitlab;

DataGitlabGroup.IsTerraformDataSource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using HashiCorp.Cdktf.Providers.Gitlab;

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

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/16.11.0/docs/data-sources/group#import import section} in the documentation of this resource for the id to use

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

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

Properties

Name	Type	Description
`Node`	`Constructs.Node`	The tree node.
`CdktfStack`	`HashiCorp.Cdktf.TerraformStack`	No description.
`Fqn`	`string`	No description.
`FriendlyUniqueId`	`string`	No description.
`TerraformMetaArguments`	`System.Collections.Generic.IDictionary<string, object>`	No description.
`TerraformResourceType`	`string`	No description.
`TerraformGeneratorMetadata`	`HashiCorp.Cdktf.TerraformProviderGeneratorMetadata`	No description.
`Count`	`object`	No description.
`DependsOn`	`string[]`	No description.
`ForEach`	`HashiCorp.Cdktf.ITerraformIterator`	No description.
`Lifecycle`	`HashiCorp.Cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`HashiCorp.Cdktf.TerraformProvider`	No description.
`DefaultBranchProtection`	`double`	No description.
`Description`	`string`	No description.
`ExtraSharedRunnersMinutesLimit`	`double`	No description.
`FullName`	`string`	No description.
`LfsEnabled`	`HashiCorp.Cdktf.IResolvable`	No description.
`MembershipLock`	`HashiCorp.Cdktf.IResolvable`	No description.
`Name`	`string`	No description.
`ParentId`	`double`	No description.
`Path`	`string`	No description.
`PreventForkingOutsideGroup`	`HashiCorp.Cdktf.IResolvable`	No description.
`RequestAccessEnabled`	`HashiCorp.Cdktf.IResolvable`	No description.
`RunnersToken`	`string`	No description.
`SharedRunnersMinutesLimit`	`double`	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`	`double`	No description.
`IdInput`	`string`	No description.
`FullPath`	`string`	No description.
`GroupId`	`double`	No description.
`Id`	`string`	No description.

`Node`^Required

public Node Node { get; }

Type: Constructs.Node

The tree node.

`CdktfStack`^Required

public TerraformStack CdktfStack { get; }

Type: HashiCorp.Cdktf.TerraformStack

`Fqn`^Required

public string Fqn { get; }

Type: string

`FriendlyUniqueId`^Required

public string FriendlyUniqueId { get; }

Type: string

`TerraformMetaArguments`^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

Type: System.Collections.Generic.IDictionary<string, object>

`TerraformResourceType`^Required

public string TerraformResourceType { get; }

Type: string

`TerraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

`Count`^Optional

public object Count { get; }

Type: object

`DependsOn`^Optional

public string[] DependsOn { get; }

Type: string[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; }

Type: HashiCorp.Cdktf.TerraformProvider

`DefaultBranchProtection`^Required

public double DefaultBranchProtection { get; }

Type: double

`Description`^Required

public string Description { get; }

Type: string

`ExtraSharedRunnersMinutesLimit`^Required

public double ExtraSharedRunnersMinutesLimit { get; }

Type: double

`FullName`^Required

public string FullName { get; }

Type: string

`LfsEnabled`^Required

public IResolvable LfsEnabled { get; }

Type: HashiCorp.Cdktf.IResolvable

`MembershipLock`^Required

public IResolvable MembershipLock { get; }

Type: HashiCorp.Cdktf.IResolvable

`Name`^Required

public string Name { get; }

Type: string

`ParentId`^Required

public double ParentId { get; }

Type: double

`Path`^Required

public string Path { get; }

Type: string

`PreventForkingOutsideGroup`^Required

public IResolvable PreventForkingOutsideGroup { get; }

Type: HashiCorp.Cdktf.IResolvable

`RequestAccessEnabled`^Required

public IResolvable RequestAccessEnabled { get; }

Type: HashiCorp.Cdktf.IResolvable

`RunnersToken`^Required

public string RunnersToken { get; }

Type: string

`SharedRunnersMinutesLimit`^Required

public double SharedRunnersMinutesLimit { get; }

Type: double

`SharedRunnersSetting`^Required

public string SharedRunnersSetting { get; }

Type: string

`SharedWithGroups`^Required

public DataGitlabGroupSharedWithGroupsList SharedWithGroups { get; }

Type: DataGitlabGroupSharedWithGroupsList

`VisibilityLevel`^Required

public string VisibilityLevel { get; }

Type: string

`WebUrl`^Required

public string WebUrl { get; }

Type: string

`WikiAccessLevel`^Required

public string WikiAccessLevel { get; }

Type: string

`FullPathInput`^Optional

public string FullPathInput { get; }

Type: string

`GroupIdInput`^Optional

public double GroupIdInput { get; }

Type: double

`IdInput`^Optional

public string IdInput { get; }

Type: string

`FullPath`^Required

public string FullPath { get; }

Type: string

`GroupId`^Required

public double GroupId { get; }

Type: double

`Id`^Required

public string Id { get; }

Type: string

Constants

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

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

DataGitlabGroupConfig

Initializer

using HashiCorp.Cdktf.Providers.Gitlab;

new DataGitlabGroupConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string FullPath = null,
    double GroupId = null,
    string Id = null
};

Properties

Name	Type	Description
`Connection`	`object`	No description.
`Count`	`object`	No description.
`DependsOn`	`HashiCorp.Cdktf.ITerraformDependable[]`	No description.
`ForEach`	`HashiCorp.Cdktf.ITerraformIterator`	No description.
`Lifecycle`	`HashiCorp.Cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`HashiCorp.Cdktf.TerraformProvider`	No description.
`Provisioners`	`object[]`	No description.
`FullPath`	`string`	The full path of the group.
`GroupId`	`double`	The ID of the group.
`Id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/data-sources/group#id DataGitlabGroup#id}.

`Connection`^Optional

public object Connection { get; set; }

Type: object

`Count`^Optional

public object Count { get; set; }

Type: object

`DependsOn`^Optional

public ITerraformDependable[] DependsOn { get; set; }

Type: HashiCorp.Cdktf.ITerraformDependable[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; set; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; set; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; set; }

Type: object[]

`FullPath`^Optional

public string FullPath { get; set; }

Type: string

The full path of the group.

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

`GroupId`^Optional

public double GroupId { get; set; }

Type: double

The ID of the group.

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

`Id`^Optional

public string Id { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/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

using HashiCorp.Cdktf.Providers.Gitlab;

new DataGitlabGroupSharedWithGroups {

};

Classes

DataGitlabGroupSharedWithGroupsList

Initializers

using HashiCorp.Cdktf.Providers.Gitlab;

new DataGitlabGroupSharedWithGroupsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);

Name	Type	Description
`TerraformResource`	`HashiCorp.Cdktf.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: HashiCorp.Cdktf.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`

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`

private string ComputeFqn()

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: HashiCorp.Cdktf.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`Get`

private DataGitlabGroupSharedWithGroupsOutputReference 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

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

public string Fqn { get; }

Type: string

DataGitlabGroupSharedWithGroupsOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Gitlab;

new DataGitlabGroupSharedWithGroupsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);

Name	Type	Description
`TerraformResource`	`HashiCorp.Cdktf.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: HashiCorp.Cdktf.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`

private string ComputeFqn()

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string Property)

`Property`^Required

Type: string

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: HashiCorp.Cdktf.IResolveContext

`ToString`

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.
`ExpiresAt`	`string`	No description.
`GroupAccessLevel`	`double`	No description.
`GroupFullPath`	`string`	No description.
`GroupId`	`double`	No description.
`GroupName`	`string`	No description.
`InternalValue`	`DataGitlabGroupSharedWithGroups`	No description.

`CreationStack`^Required

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

public string Fqn { get; }

Type: string

`ExpiresAt`^Required

public string ExpiresAt { get; }

Type: string

`GroupAccessLevel`^Required

public double GroupAccessLevel { get; }

Type: double

`GroupFullPath`^Required

public string GroupFullPath { get; }

Type: string

`GroupId`^Required

public double GroupId { get; }

Type: double

`GroupName`^Required

public string GroupName { get; }

Type: string

`InternalValue`^Optional

public DataGitlabGroupSharedWithGroups InternalValue { get; }

Type: DataGitlabGroupSharedWithGroups

Files

dataGitlabGroup.csharp.md

Latest commit

History

dataGitlabGroup.csharp.md

File metadata and controls

dataGitlabGroup Submodule

Constructs