Skip to content

Latest commit

 

History

History
2344 lines (1436 loc) · 116 KB

projectProtectedEnvironment.typescript.md

File metadata and controls

2344 lines (1436 loc) · 116 KB

projectProtectedEnvironment Submodule

Constructs

ProjectProtectedEnvironment

Represents a {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/project_protected_environment gitlab_project_protected_environment}.

Initializers

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

new projectProtectedEnvironment.ProjectProtectedEnvironment(scope: Construct, id: string, config: ProjectProtectedEnvironmentConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config ProjectProtectedEnvironmentConfig 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 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".
putApprovalRules No description.
putDeployAccessLevels No description.
resetApprovalRules No description.
resetDeployAccessLevels No description.
resetRequiredApprovalCount 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
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.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


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

hasResourceMove
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string

providerOptional
  • Type: cdktf.TerraformProvider

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • 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.

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

moveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.


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

idRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".


putApprovalRules
public putApprovalRules(value: IResolvable | ProjectProtectedEnvironmentApprovalRules[]): void
valueRequired

putDeployAccessLevels
public putDeployAccessLevels(value: IResolvable | ProjectProtectedEnvironmentDeployAccessLevels[]): void
valueRequired

resetApprovalRules
public resetApprovalRules(): void
resetDeployAccessLevels
public resetDeployAccessLevels(): void
resetRequiredApprovalCount
public resetRequiredApprovalCount(): 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 ProjectProtectedEnvironment resource upon running "cdktf plan ".

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

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

projectProtectedEnvironment.ProjectProtectedEnvironment.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { projectProtectedEnvironment } from '@cdktf/provider-gitlab'

projectProtectedEnvironment.ProjectProtectedEnvironment.isTerraformResource(x: any)
xRequired
  • Type: any

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

projectProtectedEnvironment.ProjectProtectedEnvironment.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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


importFromIdRequired
  • Type: string

The id of the existing ProjectProtectedEnvironment that should be imported.

Refer to the {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/project_protected_environment#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 ProjectProtectedEnvironment 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.
approvalRules ProjectProtectedEnvironmentApprovalRulesList No description.
deployAccessLevels ProjectProtectedEnvironmentDeployAccessLevelsList No description.
id string No description.
approvalRulesInput cdktf.IResolvable | ProjectProtectedEnvironmentApprovalRules[] No description.
deployAccessLevelsInput cdktf.IResolvable | ProjectProtectedEnvironmentDeployAccessLevels[] No description.
environmentInput string No description.
projectInput string No description.
requiredApprovalCountInput number No description.
environment string No description.
project string No description.
requiredApprovalCount number 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

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

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

approvalRulesRequired
public readonly approvalRules: ProjectProtectedEnvironmentApprovalRulesList;

deployAccessLevelsRequired
public readonly deployAccessLevels: ProjectProtectedEnvironmentDeployAccessLevelsList;

idRequired
public readonly id: string;
  • Type: string

approvalRulesInputOptional
public readonly approvalRulesInput: IResolvable | ProjectProtectedEnvironmentApprovalRules[];

deployAccessLevelsInputOptional
public readonly deployAccessLevelsInput: IResolvable | ProjectProtectedEnvironmentDeployAccessLevels[];

environmentInputOptional
public readonly environmentInput: string;
  • Type: string

projectInputOptional
public readonly projectInput: string;
  • Type: string

requiredApprovalCountInputOptional
public readonly requiredApprovalCountInput: number;
  • Type: number

environmentRequired
public readonly environment: string;
  • Type: string

projectRequired
public readonly project: string;
  • Type: string

requiredApprovalCountRequired
public readonly requiredApprovalCount: number;
  • Type: number

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

ProjectProtectedEnvironmentApprovalRules

Initializer

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

const projectProtectedEnvironmentApprovalRules: projectProtectedEnvironment.ProjectProtectedEnvironmentApprovalRules = { ... }

Properties

Name Type Description
accessLevel string Levels of access allowed to approve a deployment to this protected environment. Valid values are developer, maintainer.
groupId number The ID of the group allowed to approve a deployment to this protected environment.
groupInheritanceType number Group inheritance allows deploy access levels to take inherited group membership into account.
requiredApprovals number The number of approval required to allow deployment to this protected environment. This is mutually exclusive with user_id.
userId number The ID of the user allowed to approve a deployment to this protected environment.

accessLevelOptional
public readonly accessLevel: string;
  • Type: string

Levels of access allowed to approve a deployment to this protected environment. Valid values are developer, maintainer.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/project_protected_environment#access_level ProjectProtectedEnvironment#access_level}


groupIdOptional
public readonly groupId: number;
  • Type: number

The ID of the group allowed to approve a deployment to this protected environment.

The project must be shared with the group. This is mutually exclusive with user_id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/project_protected_environment#group_id ProjectProtectedEnvironment#group_id}


groupInheritanceTypeOptional
public readonly groupInheritanceType: number;
  • Type: number

Group inheritance allows deploy access levels to take inherited group membership into account.

Valid values are 0, 1. 0 => Direct group membership only, 1 => All inherited groups. Default: 0

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/project_protected_environment#group_inheritance_type ProjectProtectedEnvironment#group_inheritance_type}


requiredApprovalsOptional
public readonly requiredApprovals: number;
  • Type: number

The number of approval required to allow deployment to this protected environment. This is mutually exclusive with user_id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/project_protected_environment#required_approvals ProjectProtectedEnvironment#required_approvals}


userIdOptional
public readonly userId: number;
  • Type: number

The ID of the user allowed to approve a deployment to this protected environment.

The user must be a member of the project. This is mutually exclusive with group_id and required_approvals.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/project_protected_environment#user_id ProjectProtectedEnvironment#user_id}


ProjectProtectedEnvironmentConfig

Initializer

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

const projectProtectedEnvironmentConfig: projectProtectedEnvironment.ProjectProtectedEnvironmentConfig = { ... }

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.
environment string The name of the environment.
project string The ID or full path of the project which the protected environment is created against.
approvalRules cdktf.IResolvable | ProjectProtectedEnvironmentApprovalRules[] Array of approval rules to deploy, with each described by a hash.
deployAccessLevels cdktf.IResolvable | ProjectProtectedEnvironmentDeployAccessLevels[] deploy_access_levels block.
requiredApprovalCount number The number of approvals required to deploy to this environment.

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

environmentRequired
public readonly environment: string;
  • Type: string

The name of the environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/project_protected_environment#environment ProjectProtectedEnvironment#environment}


projectRequired
public readonly project: string;
  • Type: string

The ID or full path of the project which the protected environment is created against.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/project_protected_environment#project ProjectProtectedEnvironment#project}


approvalRulesOptional
public readonly approvalRules: IResolvable | ProjectProtectedEnvironmentApprovalRules[];

Array of approval rules to deploy, with each described by a hash.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/project_protected_environment#approval_rules ProjectProtectedEnvironment#approval_rules}


deployAccessLevelsOptional
public readonly deployAccessLevels: IResolvable | ProjectProtectedEnvironmentDeployAccessLevels[];

deploy_access_levels block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/project_protected_environment#deploy_access_levels ProjectProtectedEnvironment#deploy_access_levels}


requiredApprovalCountOptional
public readonly requiredApprovalCount: number;
  • Type: number

The number of approvals required to deploy to this environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/project_protected_environment#required_approval_count ProjectProtectedEnvironment#required_approval_count}


ProjectProtectedEnvironmentDeployAccessLevels

Initializer

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

const projectProtectedEnvironmentDeployAccessLevels: projectProtectedEnvironment.ProjectProtectedEnvironmentDeployAccessLevels = { ... }

Properties

Name Type Description
accessLevel string Levels of access required to deploy to this protected environment. Valid values are developer, maintainer.
groupId number The ID of the group allowed to deploy to this protected environment.
groupInheritanceType number Group inheritance allows deploy access levels to take inherited group membership into account.
userId number The ID of the user allowed to deploy to this protected environment.

accessLevelOptional
public readonly accessLevel: string;
  • Type: string

Levels of access required to deploy to this protected environment. Valid values are developer, maintainer.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/project_protected_environment#access_level ProjectProtectedEnvironment#access_level}


groupIdOptional
public readonly groupId: number;
  • Type: number

The ID of the group allowed to deploy to this protected environment.

The project must be shared with the group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/project_protected_environment#group_id ProjectProtectedEnvironment#group_id}


groupInheritanceTypeOptional
public readonly groupInheritanceType: number;
  • Type: number

Group inheritance allows deploy access levels to take inherited group membership into account.

Valid values are 0, 1. 0 => Direct group membership only, 1 => All inherited groups. Default: 0

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/project_protected_environment#group_inheritance_type ProjectProtectedEnvironment#group_inheritance_type}


userIdOptional
public readonly userId: number;
  • Type: number

The ID of the user allowed to deploy to this protected environment.

The user must be a member of the project.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/project_protected_environment#user_id ProjectProtectedEnvironment#user_id}


Classes

ProjectProtectedEnvironmentApprovalRulesList

Initializers

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

new projectProtectedEnvironment.ProjectProtectedEnvironmentApprovalRulesList(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): ProjectProtectedEnvironmentApprovalRulesOutputReference
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 | ProjectProtectedEnvironmentApprovalRules[] 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 | ProjectProtectedEnvironmentApprovalRules[];

ProjectProtectedEnvironmentApprovalRulesOutputReference

Initializers

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

new projectProtectedEnvironment.ProjectProtectedEnvironmentApprovalRulesOutputReference(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.
resetAccessLevel No description.
resetGroupId No description.
resetGroupInheritanceType No description.
resetRequiredApprovals 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.

resetAccessLevel
public resetAccessLevel(): void
resetGroupId
public resetGroupId(): void
resetGroupInheritanceType
public resetGroupInheritanceType(): void
resetRequiredApprovals
public resetRequiredApprovals(): 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.
accessLevelDescription string No description.
id number No description.
accessLevelInput string No description.
groupIdInput number No description.
groupInheritanceTypeInput number No description.
requiredApprovalsInput number No description.
userIdInput number No description.
accessLevel string No description.
groupId number No description.
groupInheritanceType number No description.
requiredApprovals number No description.
userId number No description.
internalValue cdktf.IResolvable | ProjectProtectedEnvironmentApprovalRules 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

accessLevelDescriptionRequired
public readonly accessLevelDescription: string;
  • Type: string

idRequired
public readonly id: number;
  • Type: number

accessLevelInputOptional
public readonly accessLevelInput: string;
  • Type: string

groupIdInputOptional
public readonly groupIdInput: number;
  • Type: number

groupInheritanceTypeInputOptional
public readonly groupInheritanceTypeInput: number;
  • Type: number

requiredApprovalsInputOptional
public readonly requiredApprovalsInput: number;
  • Type: number

userIdInputOptional
public readonly userIdInput: number;
  • Type: number

accessLevelRequired
public readonly accessLevel: string;
  • Type: string

groupIdRequired
public readonly groupId: number;
  • Type: number

groupInheritanceTypeRequired
public readonly groupInheritanceType: number;
  • Type: number

requiredApprovalsRequired
public readonly requiredApprovals: number;
  • Type: number

userIdRequired
public readonly userId: number;
  • Type: number

internalValueOptional
public readonly internalValue: IResolvable | ProjectProtectedEnvironmentApprovalRules;

ProjectProtectedEnvironmentDeployAccessLevelsList

Initializers

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

new projectProtectedEnvironment.ProjectProtectedEnvironmentDeployAccessLevelsList(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): ProjectProtectedEnvironmentDeployAccessLevelsOutputReference
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 | ProjectProtectedEnvironmentDeployAccessLevels[] 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 | ProjectProtectedEnvironmentDeployAccessLevels[];

ProjectProtectedEnvironmentDeployAccessLevelsOutputReference

Initializers

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

new projectProtectedEnvironment.ProjectProtectedEnvironmentDeployAccessLevelsOutputReference(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.
resetAccessLevel No description.
resetGroupId No description.
resetGroupInheritanceType 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.

resetAccessLevel
public resetAccessLevel(): void
resetGroupId
public resetGroupId(): void
resetGroupInheritanceType
public resetGroupInheritanceType(): 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.
accessLevelDescription string No description.
id number No description.
accessLevelInput string No description.
groupIdInput number No description.
groupInheritanceTypeInput number No description.
userIdInput number No description.
accessLevel string No description.
groupId number No description.
groupInheritanceType number No description.
userId number No description.
internalValue cdktf.IResolvable | ProjectProtectedEnvironmentDeployAccessLevels 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

accessLevelDescriptionRequired
public readonly accessLevelDescription: string;
  • Type: string

idRequired
public readonly id: number;
  • Type: number

accessLevelInputOptional
public readonly accessLevelInput: string;
  • Type: string

groupIdInputOptional
public readonly groupIdInput: number;
  • Type: number

groupInheritanceTypeInputOptional
public readonly groupInheritanceTypeInput: number;
  • Type: number

userIdInputOptional
public readonly userIdInput: number;
  • Type: number

accessLevelRequired
public readonly accessLevel: string;
  • Type: string

groupIdRequired
public readonly groupId: number;
  • Type: number

groupInheritanceTypeRequired
public readonly groupInheritanceType: number;
  • Type: number

userIdRequired
public readonly userId: number;
  • Type: number

internalValueOptional
public readonly internalValue: IResolvable | ProjectProtectedEnvironmentDeployAccessLevels;