Represents a {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_ldap_link gitlab_group_ldap_link}.
import { groupLdapLink } from '@cdktf/provider-gitlab'
new groupLdapLink.GroupLdapLink(scope: Construct, id: string, config: GroupLdapLinkConfig)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
string |
The scoped construct ID. |
config |
GroupLdapLinkConfig |
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
- Type: GroupLdapLinkConfig
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 |
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". |
resetAccessLevel |
No description. |
resetCn |
No description. |
resetFilter |
No description. |
resetForce |
No description. |
resetGroupAccess |
No description. |
resetId |
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
public toMetadata(): any
public toTerraform(): any
Adds this resource to the terraform JSON output.
public addMoveTarget(moveTarget: string): void
Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
- Type: string
The string move target that will correspond to this resource.
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 hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
public importFrom(id: string, provider?: TerraformProvider): void
- Type: string
- Type: cdktf.TerraformProvider
public interpolationForAttribute(terraformAttribute: string): IResolvable
- Type: string
public moveFromId(id: string): void
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.
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
public moveTo(moveTarget: string, index?: string | number): void
Moves this resource to the target resource given by moveTarget.
- Type: string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: string | number
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
public moveToId(id: string): void
Moves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
public resetAccessLevel(): void
public resetCn(): void
public resetFilter(): void
public resetForce(): void
public resetGroupAccess(): void
public resetId(): void
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a GroupLdapLink resource upon running "cdktf plan ". |
import { groupLdapLink } from '@cdktf/provider-gitlab'
groupLdapLink.GroupLdapLink.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 { groupLdapLink } from '@cdktf/provider-gitlab'
groupLdapLink.GroupLdapLink.isTerraformElement(x: any)
- Type: any
import { groupLdapLink } from '@cdktf/provider-gitlab'
groupLdapLink.GroupLdapLink.isTerraformResource(x: any)
- Type: any
import { groupLdapLink } from '@cdktf/provider-gitlab'
groupLdapLink.GroupLdapLink.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)
Generates CDKTF code for importing a GroupLdapLink 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 GroupLdapLink to import.
- Type: string
The id of the existing GroupLdapLink that should be imported.
Refer to the {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_ldap_link#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the GroupLdapLink 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. |
connection |
cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection |
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. |
provisioners |
cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] |
No description. |
accessLevelInput |
string |
No description. |
cnInput |
string |
No description. |
filterInput |
string |
No description. |
forceInput |
boolean | cdktf.IResolvable |
No description. |
groupAccessInput |
string |
No description. |
groupInput |
string |
No description. |
idInput |
string |
No description. |
ldapProviderInput |
string |
No description. |
accessLevel |
string |
No description. |
cn |
string |
No description. |
filter |
string |
No description. |
force |
boolean | cdktf.IResolvable |
No description. |
group |
string |
No description. |
groupAccess |
string |
No description. |
id |
string |
No description. |
ldapProvider |
string |
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 connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
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 provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly accessLevelInput: string;
- Type: string
public readonly cnInput: string;
- Type: string
public readonly filterInput: string;
- Type: string
public readonly forceInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly groupAccessInput: string;
- Type: string
public readonly groupInput: string;
- Type: string
public readonly idInput: string;
- Type: string
public readonly ldapProviderInput: string;
- Type: string
public readonly accessLevel: string;
- Type: string
public readonly cn: string;
- Type: string
public readonly filter: string;
- Type: string
public readonly force: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly group: string;
- Type: string
public readonly groupAccess: string;
- Type: string
public readonly id: string;
- Type: string
public readonly ldapProvider: string;
- Type: string
Name | Type | Description |
---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;
- Type: string
import { groupLdapLink } from '@cdktf/provider-gitlab'
const groupLdapLinkConfig: groupLdapLink.GroupLdapLinkConfig = { ... }
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. |
group |
string |
The ID or URL-encoded path of the group. |
ldapProvider |
string |
The name of the LDAP provider as stored in the GitLab database. |
accessLevel |
string |
Minimum access level for members of the LDAP group. |
cn |
string |
The CN of the LDAP group to link with. Required if filter is not provided. |
filter |
string |
The LDAP filter for the group. Required if cn is not provided. Requires GitLab Premium or above. |
force |
boolean | cdktf.IResolvable |
If true, then delete and replace an existing LDAP link if one exists. |
groupAccess |
string |
Minimum access level for members of the LDAP group. |
id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_ldap_link#id GroupLdapLink#id}. |
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 group: string;
- Type: string
The ID or URL-encoded path of the group.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_ldap_link#group GroupLdapLink#group}
public readonly ldapProvider: string;
- Type: string
The name of the LDAP provider as stored in the GitLab database.
Note that this is NOT the value of the label
attribute as shown in the web UI. In most cases this will be ldapmain
but you may use the LDAP check rake task for receiving the LDAP server name: LDAP: ... Server: ldapmain
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_ldap_link#ldap_provider GroupLdapLink#ldap_provider}
public readonly accessLevel: string;
- Type: string
Minimum access level for members of the LDAP group.
Valid values are: no one
, minimal
, guest
, reporter
, developer
, maintainer
, owner
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_ldap_link#access_level GroupLdapLink#access_level}
public readonly cn: string;
- Type: string
The CN of the LDAP group to link with. Required if filter
is not provided.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_ldap_link#cn GroupLdapLink#cn}
public readonly filter: string;
- Type: string
The LDAP filter for the group. Required if cn
is not provided. Requires GitLab Premium or above.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_ldap_link#filter GroupLdapLink#filter}
public readonly force: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
If true, then delete and replace an existing LDAP link if one exists.
Will also remove an LDAP link if the parent group is not found.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_ldap_link#force GroupLdapLink#force}
public readonly groupAccess: string;
- Type: string
Minimum access level for members of the LDAP group.
Valid values are: no one
, minimal
, guest
, reporter
, developer
, maintainer
, owner
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_ldap_link#group_access GroupLdapLink#group_access}
public readonly id: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_ldap_link#id GroupLdapLink#id}.
Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.