Skip to content

Latest commit

 

History

History
3043 lines (1872 loc) · 133 KB

dataGitlabProject.typescript.md

File metadata and controls

3043 lines (1872 loc) · 133 KB

dataGitlabProject Submodule

Constructs

DataGitlabProject

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

Initializers

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

new dataGitlabProject.DataGitlabProject(scope: Construct, id: string, config?: DataGitlabProjectConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config DataGitlabProjectConfig No description.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configOptional

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.
resetCiDefaultGitDepth No description.
resetId No description.
resetPathWithNamespace No description.
resetPublicBuilds No description.

toString
public toString(): string

Returns a string representation of this construct.

addOverride
public addOverride(path: string, value: any): void
pathRequired
  • Type: string

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • 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}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

resetCiDefaultGitDepth
public resetCiDefaultGitDepth(): void
resetId
public resetId(): void
resetPathWithNamespace
public resetPathWithNamespace(): void
resetPublicBuilds
public resetPublicBuilds(): 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 DataGitlabProject resource upon running "cdktf plan ".

isConstruct
import { dataGitlabProject } from '@cdktf/provider-gitlab'

dataGitlabProject.DataGitlabProject.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.

xRequired
  • Type: any

Any object.


isTerraformElement
import { dataGitlabProject } from '@cdktf/provider-gitlab'

dataGitlabProject.DataGitlabProject.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformDataSource
import { dataGitlabProject } from '@cdktf/provider-gitlab'

dataGitlabProject.DataGitlabProject.isTerraformDataSource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { dataGitlabProject } from '@cdktf/provider-gitlab'

dataGitlabProject.DataGitlabProject.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: string

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


importFromIdRequired
  • Type: string

The id of the existing DataGitlabProject that should be imported.

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


providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the DataGitlabProject 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.
analyticsAccessLevel string No description.
archived cdktf.IResolvable No description.
autoCancelPendingPipelines string No description.
autocloseReferencedIssues cdktf.IResolvable No description.
autoDevopsDeployStrategy string No description.
autoDevopsEnabled cdktf.IResolvable No description.
buildGitStrategy string No description.
buildsAccessLevel string No description.
buildTimeout number No description.
ciConfigPath string No description.
ciRestrictPipelineCancellationRole string No description.
ciSeparatedCaches cdktf.IResolvable No description.
containerExpirationPolicy DataGitlabProjectContainerExpirationPolicyList No description.
containerRegistryAccessLevel string No description.
defaultBranch string No description.
description string No description.
emailsEnabled cdktf.IResolvable No description.
emptyRepo cdktf.IResolvable No description.
environmentsAccessLevel string No description.
externalAuthorizationClassificationLabel string No description.
featureFlagsAccessLevel string No description.
forkingAccessLevel string No description.
httpUrlToRepo string No description.
importUrl string No description.
infrastructureAccessLevel string No description.
issuesAccessLevel string No description.
issuesEnabled cdktf.IResolvable No description.
keepLatestArtifact cdktf.IResolvable No description.
lfsEnabled cdktf.IResolvable No description.
mergeCommitTemplate string No description.
mergePipelinesEnabled cdktf.IResolvable No description.
mergeRequestsAccessLevel string No description.
mergeRequestsEnabled cdktf.IResolvable No description.
mergeTrainsEnabled cdktf.IResolvable No description.
monitorAccessLevel string No description.
name string No description.
namespaceId number No description.
path string No description.
pipelinesEnabled cdktf.IResolvable No description.
printingMergeRequestLinkEnabled cdktf.IResolvable No description.
pushRules DataGitlabProjectPushRulesList No description.
releasesAccessLevel string No description.
removeSourceBranchAfterMerge cdktf.IResolvable No description.
repositoryAccessLevel string No description.
repositoryStorage string No description.
requestAccessEnabled cdktf.IResolvable No description.
requirementsAccessLevel string No description.
resolveOutdatedDiffDiscussions cdktf.IResolvable No description.
restrictUserDefinedVariables cdktf.IResolvable No description.
runnersToken string No description.
securityAndComplianceAccessLevel string No description.
sharedWithGroups DataGitlabProjectSharedWithGroupsList No description.
snippetsAccessLevel string No description.
snippetsEnabled cdktf.IResolvable No description.
squashCommitTemplate string No description.
sshUrlToRepo string No description.
suggestionCommitMessage string No description.
topics string[] No description.
visibilityLevel string No description.
webUrl string No description.
wikiAccessLevel string No description.
wikiEnabled cdktf.IResolvable No description.
ciDefaultGitDepthInput number No description.
idInput string No description.
pathWithNamespaceInput string No description.
publicBuildsInput boolean | cdktf.IResolvable No description.
ciDefaultGitDepth number No description.
id string No description.
pathWithNamespace string No description.
publicBuilds boolean | cdktf.IResolvable No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

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

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

analyticsAccessLevelRequired
public readonly analyticsAccessLevel: string;
  • Type: string

archivedRequired
public readonly archived: IResolvable;
  • Type: cdktf.IResolvable

autoCancelPendingPipelinesRequired
public readonly autoCancelPendingPipelines: string;
  • Type: string

autocloseReferencedIssuesRequired
public readonly autocloseReferencedIssues: IResolvable;
  • Type: cdktf.IResolvable

autoDevopsDeployStrategyRequired
public readonly autoDevopsDeployStrategy: string;
  • Type: string

autoDevopsEnabledRequired
public readonly autoDevopsEnabled: IResolvable;
  • Type: cdktf.IResolvable

buildGitStrategyRequired
public readonly buildGitStrategy: string;
  • Type: string

buildsAccessLevelRequired
public readonly buildsAccessLevel: string;
  • Type: string

buildTimeoutRequired
public readonly buildTimeout: number;
  • Type: number

ciConfigPathRequired
public readonly ciConfigPath: string;
  • Type: string

ciRestrictPipelineCancellationRoleRequired
public readonly ciRestrictPipelineCancellationRole: string;
  • Type: string

ciSeparatedCachesRequired
public readonly ciSeparatedCaches: IResolvable;
  • Type: cdktf.IResolvable

containerExpirationPolicyRequired
public readonly containerExpirationPolicy: DataGitlabProjectContainerExpirationPolicyList;

containerRegistryAccessLevelRequired
public readonly containerRegistryAccessLevel: string;
  • Type: string

defaultBranchRequired
public readonly defaultBranch: string;
  • Type: string

descriptionRequired
public readonly description: string;
  • Type: string

emailsEnabledRequired
public readonly emailsEnabled: IResolvable;
  • Type: cdktf.IResolvable

emptyRepoRequired
public readonly emptyRepo: IResolvable;
  • Type: cdktf.IResolvable

environmentsAccessLevelRequired
public readonly environmentsAccessLevel: string;
  • Type: string

externalAuthorizationClassificationLabelRequired
public readonly externalAuthorizationClassificationLabel: string;
  • Type: string

featureFlagsAccessLevelRequired
public readonly featureFlagsAccessLevel: string;
  • Type: string

forkingAccessLevelRequired
public readonly forkingAccessLevel: string;
  • Type: string

httpUrlToRepoRequired
public readonly httpUrlToRepo: string;
  • Type: string

importUrlRequired
public readonly importUrl: string;
  • Type: string

infrastructureAccessLevelRequired
public readonly infrastructureAccessLevel: string;
  • Type: string

issuesAccessLevelRequired
public readonly issuesAccessLevel: string;
  • Type: string

issuesEnabledRequired
public readonly issuesEnabled: IResolvable;
  • Type: cdktf.IResolvable

keepLatestArtifactRequired
public readonly keepLatestArtifact: IResolvable;
  • Type: cdktf.IResolvable

lfsEnabledRequired
public readonly lfsEnabled: IResolvable;
  • Type: cdktf.IResolvable

mergeCommitTemplateRequired
public readonly mergeCommitTemplate: string;
  • Type: string

mergePipelinesEnabledRequired
public readonly mergePipelinesEnabled: IResolvable;
  • Type: cdktf.IResolvable

mergeRequestsAccessLevelRequired
public readonly mergeRequestsAccessLevel: string;
  • Type: string

mergeRequestsEnabledRequired
public readonly mergeRequestsEnabled: IResolvable;
  • Type: cdktf.IResolvable

mergeTrainsEnabledRequired
public readonly mergeTrainsEnabled: IResolvable;
  • Type: cdktf.IResolvable

monitorAccessLevelRequired
public readonly monitorAccessLevel: string;
  • Type: string

nameRequired
public readonly name: string;
  • Type: string

namespaceIdRequired
public readonly namespaceId: number;
  • Type: number

pathRequired
public readonly path: string;
  • Type: string

pipelinesEnabledRequired
public readonly pipelinesEnabled: IResolvable;
  • Type: cdktf.IResolvable

printingMergeRequestLinkEnabledRequired
public readonly printingMergeRequestLinkEnabled: IResolvable;
  • Type: cdktf.IResolvable

pushRulesRequired
public readonly pushRules: DataGitlabProjectPushRulesList;

releasesAccessLevelRequired
public readonly releasesAccessLevel: string;
  • Type: string

removeSourceBranchAfterMergeRequired
public readonly removeSourceBranchAfterMerge: IResolvable;
  • Type: cdktf.IResolvable

repositoryAccessLevelRequired
public readonly repositoryAccessLevel: string;
  • Type: string

repositoryStorageRequired
public readonly repositoryStorage: string;
  • Type: string

requestAccessEnabledRequired
public readonly requestAccessEnabled: IResolvable;
  • Type: cdktf.IResolvable

requirementsAccessLevelRequired
public readonly requirementsAccessLevel: string;
  • Type: string

resolveOutdatedDiffDiscussionsRequired
public readonly resolveOutdatedDiffDiscussions: IResolvable;
  • Type: cdktf.IResolvable

restrictUserDefinedVariablesRequired
public readonly restrictUserDefinedVariables: IResolvable;
  • Type: cdktf.IResolvable

runnersTokenRequired
public readonly runnersToken: string;
  • Type: string

securityAndComplianceAccessLevelRequired
public readonly securityAndComplianceAccessLevel: string;
  • Type: string

sharedWithGroupsRequired
public readonly sharedWithGroups: DataGitlabProjectSharedWithGroupsList;

snippetsAccessLevelRequired
public readonly snippetsAccessLevel: string;
  • Type: string

snippetsEnabledRequired
public readonly snippetsEnabled: IResolvable;
  • Type: cdktf.IResolvable

squashCommitTemplateRequired
public readonly squashCommitTemplate: string;
  • Type: string

sshUrlToRepoRequired
public readonly sshUrlToRepo: string;
  • Type: string

suggestionCommitMessageRequired
public readonly suggestionCommitMessage: string;
  • Type: string

topicsRequired
public readonly topics: string[];
  • Type: string[]

visibilityLevelRequired
public readonly visibilityLevel: string;
  • Type: string

webUrlRequired
public readonly webUrl: string;
  • Type: string

wikiAccessLevelRequired
public readonly wikiAccessLevel: string;
  • Type: string

wikiEnabledRequired
public readonly wikiEnabled: IResolvable;
  • Type: cdktf.IResolvable

ciDefaultGitDepthInputOptional
public readonly ciDefaultGitDepthInput: number;
  • Type: number

idInputOptional
public readonly idInput: string;
  • Type: string

pathWithNamespaceInputOptional
public readonly pathWithNamespaceInput: string;
  • Type: string

publicBuildsInputOptional
public readonly publicBuildsInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

ciDefaultGitDepthRequired
public readonly ciDefaultGitDepth: number;
  • Type: number

idRequired
public readonly id: string;
  • Type: string

pathWithNamespaceRequired
public readonly pathWithNamespace: string;
  • Type: string

publicBuildsRequired
public readonly publicBuilds: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

DataGitlabProjectConfig

Initializer

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

const dataGitlabProjectConfig: dataGitlabProject.DataGitlabProjectConfig = { ... }

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.
ciDefaultGitDepth number Default number of revisions for shallow cloning.
id string The integer that uniquely identifies the project within the gitlab install.
pathWithNamespace string The path of the repository with namespace.
publicBuilds boolean | cdktf.IResolvable If true, jobs can be viewed by non-project members.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

ciDefaultGitDepthOptional
public readonly ciDefaultGitDepth: number;
  • Type: number

Default number of revisions for shallow cloning.

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


idOptional
public readonly id: string;
  • Type: string

The integer that uniquely identifies the project within the gitlab install.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/data-sources/project#id DataGitlabProject#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.


pathWithNamespaceOptional
public readonly pathWithNamespace: string;
  • Type: string

The path of the repository with namespace.

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


publicBuildsOptional
public readonly publicBuilds: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

If true, jobs can be viewed by non-project members.

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


DataGitlabProjectContainerExpirationPolicy

Initializer

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

const dataGitlabProjectContainerExpirationPolicy: dataGitlabProject.DataGitlabProjectContainerExpirationPolicy = { ... }

DataGitlabProjectPushRules

Initializer

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

const dataGitlabProjectPushRules: dataGitlabProject.DataGitlabProjectPushRules = { ... }

DataGitlabProjectSharedWithGroups

Initializer

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

const dataGitlabProjectSharedWithGroups: dataGitlabProject.DataGitlabProjectSharedWithGroups = { ... }

Classes

DataGitlabProjectContainerExpirationPolicyList

Initializers

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

new dataGitlabProject.DataGitlabProjectContainerExpirationPolicyList(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).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


wrapsSetRequired
  • 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.

mapKeyAttributeNameRequired
  • Type: string

computeFqn
public computeFqn(): string
resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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): DataGitlabProjectContainerExpirationPolicyOutputReference
indexRequired
  • 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.

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


fqnRequired
public readonly fqn: string;
  • Type: string

DataGitlabProjectContainerExpirationPolicyOutputReference

Initializers

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

new dataGitlabProject.DataGitlabProjectContainerExpirationPolicyOutputReference(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).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


complexObjectIndexRequired
  • Type: number

the index of this item in the list.


complexObjectIsFromSetRequired
  • 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}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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.
cadence string No description.
enabled cdktf.IResolvable No description.
keepN number No description.
nameRegex string No description.
nameRegexDelete string No description.
nameRegexKeep string No description.
nextRunAt string No description.
olderThan string No description.
internalValue DataGitlabProjectContainerExpirationPolicy No description.

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


fqnRequired
public readonly fqn: string;
  • Type: string

cadenceRequired
public readonly cadence: string;
  • Type: string

enabledRequired
public readonly enabled: IResolvable;
  • Type: cdktf.IResolvable

keepNRequired
public readonly keepN: number;
  • Type: number

nameRegexRequired
public readonly nameRegex: string;
  • Type: string

nameRegexDeleteRequired
public readonly nameRegexDelete: string;
  • Type: string

nameRegexKeepRequired
public readonly nameRegexKeep: string;
  • Type: string

nextRunAtRequired
public readonly nextRunAt: string;
  • Type: string

olderThanRequired
public readonly olderThan: string;
  • Type: string

internalValueOptional
public readonly internalValue: DataGitlabProjectContainerExpirationPolicy;

DataGitlabProjectPushRulesList

Initializers

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

new dataGitlabProject.DataGitlabProjectPushRulesList(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).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


wrapsSetRequired
  • 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.

mapKeyAttributeNameRequired
  • Type: string

computeFqn
public computeFqn(): string
resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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): DataGitlabProjectPushRulesOutputReference
indexRequired
  • 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.

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


fqnRequired
public readonly fqn: string;
  • Type: string

DataGitlabProjectPushRulesOutputReference

Initializers

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

new dataGitlabProject.DataGitlabProjectPushRulesOutputReference(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).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


complexObjectIndexRequired
  • Type: number

the index of this item in the list.


complexObjectIsFromSetRequired
  • 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}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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.
authorEmailRegex string No description.
branchNameRegex string No description.
commitCommitterCheck cdktf.IResolvable No description.
commitCommitterNameCheck cdktf.IResolvable No description.
commitMessageNegativeRegex string No description.
commitMessageRegex string No description.
denyDeleteTag cdktf.IResolvable No description.
fileNameRegex string No description.
maxFileSize number No description.
memberCheck cdktf.IResolvable No description.
preventSecrets cdktf.IResolvable No description.
rejectUnsignedCommits cdktf.IResolvable No description.
internalValue DataGitlabProjectPushRules No description.

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


fqnRequired
public readonly fqn: string;
  • Type: string

authorEmailRegexRequired
public readonly authorEmailRegex: string;
  • Type: string

branchNameRegexRequired
public readonly branchNameRegex: string;
  • Type: string

commitCommitterCheckRequired
public readonly commitCommitterCheck: IResolvable;
  • Type: cdktf.IResolvable

commitCommitterNameCheckRequired
public readonly commitCommitterNameCheck: IResolvable;
  • Type: cdktf.IResolvable

commitMessageNegativeRegexRequired
public readonly commitMessageNegativeRegex: string;
  • Type: string

commitMessageRegexRequired
public readonly commitMessageRegex: string;
  • Type: string

denyDeleteTagRequired
public readonly denyDeleteTag: IResolvable;
  • Type: cdktf.IResolvable

fileNameRegexRequired
public readonly fileNameRegex: string;
  • Type: string

maxFileSizeRequired
public readonly maxFileSize: number;
  • Type: number

memberCheckRequired
public readonly memberCheck: IResolvable;
  • Type: cdktf.IResolvable

preventSecretsRequired
public readonly preventSecrets: IResolvable;
  • Type: cdktf.IResolvable

rejectUnsignedCommitsRequired
public readonly rejectUnsignedCommits: IResolvable;
  • Type: cdktf.IResolvable

internalValueOptional
public readonly internalValue: DataGitlabProjectPushRules;

DataGitlabProjectSharedWithGroupsList

Initializers

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

new dataGitlabProject.DataGitlabProjectSharedWithGroupsList(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).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


wrapsSetRequired
  • 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.

mapKeyAttributeNameRequired
  • Type: string

computeFqn
public computeFqn(): string
resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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): DataGitlabProjectSharedWithGroupsOutputReference
indexRequired
  • 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.

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


fqnRequired
public readonly fqn: string;
  • Type: string

DataGitlabProjectSharedWithGroupsOutputReference

Initializers

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

new dataGitlabProject.DataGitlabProjectSharedWithGroupsOutputReference(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).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


complexObjectIndexRequired
  • Type: number

the index of this item in the list.


complexObjectIsFromSetRequired
  • 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}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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.
groupAccessLevel number No description.
groupFullPath string No description.
groupId number No description.
groupName string No description.
internalValue DataGitlabProjectSharedWithGroups No description.

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


fqnRequired
public readonly fqn: string;
  • Type: string

groupAccessLevelRequired
public readonly groupAccessLevel: number;
  • Type: number

groupFullPathRequired
public readonly groupFullPath: string;
  • Type: string

groupIdRequired
public readonly groupId: number;
  • Type: number

groupNameRequired
public readonly groupName: string;
  • Type: string

internalValueOptional
public readonly internalValue: DataGitlabProjectSharedWithGroups;