projectAccessToken.typescript.md

projectAccessToken Submodule

Constructs

ProjectAccessToken

Represents a {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_access_token gitlab_project_access_token}.

Initializers

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

new projectAccessToken.ProjectAccessToken(scope: Construct, id: string, config: ProjectAccessTokenConfig)

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

---

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	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".
putRotationConfiguration	No description.
resetAccessLevel	No description.
resetExpiresAt	No description.
resetRotationConfiguration	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

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

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.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

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

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

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.

id^Required

• Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

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 | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

---

moveToId

public moveToId(id: string): void

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".

---

putRotationConfiguration

public putRotationConfiguration(value: ProjectAccessTokenRotationConfiguration): void

value^Required

• Type: ProjectAccessTokenRotationConfiguration

---

resetAccessLevel

public resetAccessLevel(): void

resetExpiresAt

public resetExpiresAt(): void

resetRotationConfiguration

public resetRotationConfiguration(): void

Static Functions

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

---

isConstruct

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

projectAccessToken.ProjectAccessToken.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 { projectAccessToken } from '@cdktf/provider-gitlab'

projectAccessToken.ProjectAccessToken.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

projectAccessToken.ProjectAccessToken.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

projectAccessToken.ProjectAccessToken.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a ProjectAccessToken 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 ProjectAccessToken to import.

---

importFromId^Required

• Type: string

The id of the existing ProjectAccessToken that should be imported.

Refer to the {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_access_token#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 ProjectAccessToken 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.
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.
active	cdktf.IResolvable	No description.
createdAt	string	No description.
id	string	No description.
revoked	cdktf.IResolvable	No description.
rotationConfiguration	ProjectAccessTokenRotationConfigurationOutputReference	No description.
token	string	No description.
userId	number	No description.
accessLevelInput	string	No description.
expiresAtInput	string	No description.
nameInput	string	No description.
projectInput	string	No description.
rotationConfigurationInput	cdktf.IResolvable | ProjectAccessTokenRotationConfiguration	No description.
scopesInput	string[]	No description.
accessLevel	string	No description.
expiresAt	string	No description.
name	string	No description.
project	string	No description.
scopes	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

---

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

---

provisioners^Optional

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

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

---

active^Required

public readonly active: IResolvable;

• Type: cdktf.IResolvable

---

createdAt^Required

public readonly createdAt: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

revoked^Required

public readonly revoked: IResolvable;

• Type: cdktf.IResolvable

---

rotationConfiguration^Required

public readonly rotationConfiguration: ProjectAccessTokenRotationConfigurationOutputReference;

• Type: ProjectAccessTokenRotationConfigurationOutputReference

---

token^Required

public readonly token: string;

• Type: string

---

userId^Required

public readonly userId: number;

• Type: number

---

accessLevelInput^Optional

public readonly accessLevelInput: string;

• Type: string

---

expiresAtInput^Optional

public readonly expiresAtInput: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

projectInput^Optional

public readonly projectInput: string;

• Type: string

---

rotationConfigurationInput^Optional

public readonly rotationConfigurationInput: IResolvable | ProjectAccessTokenRotationConfiguration;

• Type: cdktf.IResolvable | ProjectAccessTokenRotationConfiguration

---

scopesInput^Optional

public readonly scopesInput: string[];

• Type: string[]

---

accessLevel^Required

public readonly accessLevel: string;

• Type: string

---

expiresAt^Required

public readonly expiresAt: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

project^Required

public readonly project: string;

• Type: string

---

scopes^Required

public readonly scopes: string[];

• Type: string[]

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

ProjectAccessTokenConfig

Initializer

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

const projectAccessTokenConfig: projectAccessToken.ProjectAccessTokenConfig = { ... }

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.
name	string	The name of the project access token.
project	string	The ID or full path of the project.
scopes	string[]	The scopes of the project access token.
accessLevel	string	The access level for the project access token.
expiresAt	string	When the token will expire, YYYY-MM-DD format. Is automatically set when rotation_configuration is used.
rotationConfiguration	ProjectAccessTokenRotationConfiguration	The configuration for when to rotate a token automatically. Will not rotate a token until terraform apply is run.

---

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[]

---

name^Required

public readonly name: string;

• Type: string

The name of the project access token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_access_token#name ProjectAccessToken#name}

---

project^Required

public readonly project: string;

• Type: string

The ID or full path of the project.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_access_token#project ProjectAccessToken#project}

---

scopes^Required

public readonly scopes: string[];

• Type: string[]

The scopes of the project access token.

valid values are: api, read_api, read_user, k8s_proxy, read_registry, write_registry, read_repository, write_repository, create_runner, ai_features, k8s_proxy, read_observability, write_observability

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_access_token#scopes ProjectAccessToken#scopes}

---

accessLevel^Optional

public readonly accessLevel: string;

• Type: string

The access level for the project access token.

Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner. Default is maintainer.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_access_token#access_level ProjectAccessToken#access_level}

---

expiresAt^Optional

public readonly expiresAt: string;

• Type: string

When the token will expire, YYYY-MM-DD format. Is automatically set when rotation_configuration is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_access_token#expires_at ProjectAccessToken#expires_at}

---

rotationConfiguration^Optional

public readonly rotationConfiguration: ProjectAccessTokenRotationConfiguration;

• Type: ProjectAccessTokenRotationConfiguration

The configuration for when to rotate a token automatically. Will not rotate a token until terraform apply is run.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_access_token#rotation_configuration ProjectAccessToken#rotation_configuration}

---

ProjectAccessTokenRotationConfiguration

Initializer

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

const projectAccessTokenRotationConfiguration: projectAccessToken.ProjectAccessTokenRotationConfiguration = { ... }

Properties

Name	Type	Description
expirationDays	number	The duration (in days) the new token should be valid for.
rotateBeforeDays	number	The duration (in days) before the expiration when the token should be rotated.

---

expirationDays^Required

public readonly expirationDays: number;

• Type: number

The duration (in days) the new token should be valid for.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_access_token#expiration_days ProjectAccessToken#expiration_days}

---

rotateBeforeDays^Required

public readonly rotateBeforeDays: number;

• Type: number

The duration (in days) before the expiration when the token should be rotated.

As an example, if set to 7 days, the token will rotate 7 days before the expiration date, but only when terraform apply is run in that timeframe.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_access_token#rotate_before_days ProjectAccessToken#rotate_before_days}

---

Classes

ProjectAccessTokenRotationConfigurationOutputReference

Initializers

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

new projectAccessToken.ProjectAccessTokenRotationConfigurationOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.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

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.
expirationDaysInput	number	No description.
rotateBeforeDaysInput	number	No description.
expirationDays	number	No description.
rotateBeforeDays	number	No description.
internalValue	cdktf.IResolvable | ProjectAccessTokenRotationConfiguration	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

---

expirationDaysInput^Optional

public readonly expirationDaysInput: number;

• Type: number

---

rotateBeforeDaysInput^Optional

public readonly rotateBeforeDaysInput: number;

• Type: number

---

expirationDays^Required

public readonly expirationDays: number;

• Type: number

---

rotateBeforeDays^Required

public readonly rotateBeforeDays: number;

• Type: number

---

internalValue^Optional

public readonly internalValue: IResolvable | ProjectAccessTokenRotationConfiguration;

• Type: cdktf.IResolvable | ProjectAccessTokenRotationConfiguration

---