Skip to content

Latest commit

 

History

History
1966 lines (1202 loc) · 102 KB

dataGitlabProjectProtectedBranch.typescript.md

File metadata and controls

1966 lines (1202 loc) · 102 KB

dataGitlabProjectProtectedBranch Submodule

Constructs

DataGitlabProjectProtectedBranch

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

Initializers

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

new dataGitlabProjectProtectedBranch.DataGitlabProjectProtectedBranch(scope: Construct, id: string, config: DataGitlabProjectProtectedBranchConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config DataGitlabProjectProtectedBranchConfig 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


configRequired

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.
putMergeAccessLevels No description.
putPushAccessLevels No description.
resetMergeAccessLevels No description.
resetPushAccessLevels 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

putMergeAccessLevels
public putMergeAccessLevels(value: IResolvable | DataGitlabProjectProtectedBranchMergeAccessLevels[]): void
valueRequired

putPushAccessLevels
public putPushAccessLevels(value: IResolvable | DataGitlabProjectProtectedBranchPushAccessLevels[]): void
valueRequired

resetMergeAccessLevels
public resetMergeAccessLevels(): void
resetPushAccessLevels
public resetPushAccessLevels(): 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 DataGitlabProjectProtectedBranch resource upon running "cdktf plan ".

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

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

dataGitlabProjectProtectedBranch.DataGitlabProjectProtectedBranch.isTerraformElement(x: any)
xRequired
  • Type: any

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

dataGitlabProjectProtectedBranch.DataGitlabProjectProtectedBranch.isTerraformDataSource(x: any)
xRequired
  • Type: any

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

dataGitlabProjectProtectedBranch.DataGitlabProjectProtectedBranch.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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


importFromIdRequired
  • Type: string

The id of the existing DataGitlabProjectProtectedBranch that should be imported.

Refer to the {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/data-sources/project_protected_branch#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 DataGitlabProjectProtectedBranch 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.
allowForcePush cdktf.IResolvable No description.
codeOwnerApprovalRequired cdktf.IResolvable No description.
id number No description.
mergeAccessLevels DataGitlabProjectProtectedBranchMergeAccessLevelsList No description.
pushAccessLevels DataGitlabProjectProtectedBranchPushAccessLevelsList No description.
mergeAccessLevelsInput cdktf.IResolvable | DataGitlabProjectProtectedBranchMergeAccessLevels[] No description.
nameInput string No description.
projectIdInput string No description.
pushAccessLevelsInput cdktf.IResolvable | DataGitlabProjectProtectedBranchPushAccessLevels[] No description.
name string No description.
projectId string 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

allowForcePushRequired
public readonly allowForcePush: IResolvable;
  • Type: cdktf.IResolvable

codeOwnerApprovalRequiredRequired
public readonly codeOwnerApprovalRequired: IResolvable;
  • Type: cdktf.IResolvable

idRequired
public readonly id: number;
  • Type: number

mergeAccessLevelsRequired
public readonly mergeAccessLevels: DataGitlabProjectProtectedBranchMergeAccessLevelsList;

pushAccessLevelsRequired
public readonly pushAccessLevels: DataGitlabProjectProtectedBranchPushAccessLevelsList;

mergeAccessLevelsInputOptional
public readonly mergeAccessLevelsInput: IResolvable | DataGitlabProjectProtectedBranchMergeAccessLevels[];

nameInputOptional
public readonly nameInput: string;
  • Type: string

projectIdInputOptional
public readonly projectIdInput: string;
  • Type: string

pushAccessLevelsInputOptional
public readonly pushAccessLevelsInput: IResolvable | DataGitlabProjectProtectedBranchPushAccessLevels[];

nameRequired
public readonly name: string;
  • Type: string

projectIdRequired
public readonly projectId: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

DataGitlabProjectProtectedBranchConfig

Initializer

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

const dataGitlabProjectProtectedBranchConfig: dataGitlabProjectProtectedBranch.DataGitlabProjectProtectedBranchConfig = { ... }

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 protected branch.
projectId string The integer or path with namespace that uniquely identifies the project.
mergeAccessLevels cdktf.IResolvable | DataGitlabProjectProtectedBranchMergeAccessLevels[] merge_access_levels block.
pushAccessLevels cdktf.IResolvable | DataGitlabProjectProtectedBranchPushAccessLevels[] push_access_levels block.

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

nameRequired
public readonly name: string;
  • Type: string

The name of the protected branch.

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


projectIdRequired
public readonly projectId: string;
  • Type: string

The integer or path with namespace that uniquely identifies the project.

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


mergeAccessLevelsOptional
public readonly mergeAccessLevels: IResolvable | DataGitlabProjectProtectedBranchMergeAccessLevels[];

merge_access_levels block.

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


pushAccessLevelsOptional
public readonly pushAccessLevels: IResolvable | DataGitlabProjectProtectedBranchPushAccessLevels[];

push_access_levels block.

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


DataGitlabProjectProtectedBranchMergeAccessLevels

Initializer

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

const dataGitlabProjectProtectedBranchMergeAccessLevels: dataGitlabProjectProtectedBranch.DataGitlabProjectProtectedBranchMergeAccessLevels = { ... }

Properties

Name Type Description
groupId number The ID of a GitLab group allowed to perform the relevant action. Mutually exclusive with user_id.
userId number The ID of a GitLab user allowed to perform the relevant action. Mutually exclusive with group_id.

groupIdOptional
public readonly groupId: number;
  • Type: number

The ID of a GitLab group allowed to perform the relevant action. Mutually exclusive with user_id.

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


userIdOptional
public readonly userId: number;
  • Type: number

The ID of a GitLab user allowed to perform the relevant action. Mutually exclusive with group_id.

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


DataGitlabProjectProtectedBranchPushAccessLevels

Initializer

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

const dataGitlabProjectProtectedBranchPushAccessLevels: dataGitlabProjectProtectedBranch.DataGitlabProjectProtectedBranchPushAccessLevels = { ... }

Properties

Name Type Description
groupId number The ID of a GitLab group allowed to perform the relevant action. Mutually exclusive with user_id.
userId number The ID of a GitLab user allowed to perform the relevant action. Mutually exclusive with group_id.

groupIdOptional
public readonly groupId: number;
  • Type: number

The ID of a GitLab group allowed to perform the relevant action. Mutually exclusive with user_id.

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


userIdOptional
public readonly userId: number;
  • Type: number

The ID of a GitLab user allowed to perform the relevant action. Mutually exclusive with group_id.

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


Classes

DataGitlabProjectProtectedBranchMergeAccessLevelsList

Initializers

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

new dataGitlabProjectProtectedBranch.DataGitlabProjectProtectedBranchMergeAccessLevelsList(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): DataGitlabProjectProtectedBranchMergeAccessLevelsOutputReference
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.
internalValue cdktf.IResolvable | DataGitlabProjectProtectedBranchMergeAccessLevels[] 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

internalValueOptional
public readonly internalValue: IResolvable | DataGitlabProjectProtectedBranchMergeAccessLevels[];

DataGitlabProjectProtectedBranchMergeAccessLevelsOutputReference

Initializers

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

new dataGitlabProjectProtectedBranch.DataGitlabProjectProtectedBranchMergeAccessLevelsOutputReference(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.
resetGroupId No description.
resetUserId No description.

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.

resetGroupId
public resetGroupId(): void
resetUserId
public resetUserId(): void

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.
accessLevel string No description.
accessLevelDescription string No description.
groupIdInput number No description.
userIdInput number No description.
groupId number No description.
userId number No description.
internalValue cdktf.IResolvable | DataGitlabProjectProtectedBranchMergeAccessLevels 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

accessLevelRequired
public readonly accessLevel: string;
  • Type: string

accessLevelDescriptionRequired
public readonly accessLevelDescription: string;
  • Type: string

groupIdInputOptional
public readonly groupIdInput: number;
  • Type: number

userIdInputOptional
public readonly userIdInput: number;
  • Type: number

groupIdRequired
public readonly groupId: number;
  • Type: number

userIdRequired
public readonly userId: number;
  • Type: number

internalValueOptional
public readonly internalValue: IResolvable | DataGitlabProjectProtectedBranchMergeAccessLevels;

DataGitlabProjectProtectedBranchPushAccessLevelsList

Initializers

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

new dataGitlabProjectProtectedBranch.DataGitlabProjectProtectedBranchPushAccessLevelsList(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): DataGitlabProjectProtectedBranchPushAccessLevelsOutputReference
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.
internalValue cdktf.IResolvable | DataGitlabProjectProtectedBranchPushAccessLevels[] 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

internalValueOptional
public readonly internalValue: IResolvable | DataGitlabProjectProtectedBranchPushAccessLevels[];

DataGitlabProjectProtectedBranchPushAccessLevelsOutputReference

Initializers

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

new dataGitlabProjectProtectedBranch.DataGitlabProjectProtectedBranchPushAccessLevelsOutputReference(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.
resetGroupId No description.
resetUserId No description.

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.

resetGroupId
public resetGroupId(): void
resetUserId
public resetUserId(): void

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.
accessLevel string No description.
accessLevelDescription string No description.
groupIdInput number No description.
userIdInput number No description.
groupId number No description.
userId number No description.
internalValue cdktf.IResolvable | DataGitlabProjectProtectedBranchPushAccessLevels 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

accessLevelRequired
public readonly accessLevel: string;
  • Type: string

accessLevelDescriptionRequired
public readonly accessLevelDescription: string;
  • Type: string

groupIdInputOptional
public readonly groupIdInput: number;
  • Type: number

userIdInputOptional
public readonly userIdInput: number;
  • Type: number

groupIdRequired
public readonly groupId: number;
  • Type: number

userIdRequired
public readonly userId: number;
  • Type: number

internalValueOptional
public readonly internalValue: IResolvable | DataGitlabProjectProtectedBranchPushAccessLevels;