repositoryEnvironment.typescript.md

repositoryEnvironment Submodule

Constructs

RepositoryEnvironment

Represents a {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/repository_environment github_repository_environment}.

Initializers

import { repositoryEnvironment } from '@cdktf/provider-github'

new repositoryEnvironment.RepositoryEnvironment(scope: Construct, id: string, config: RepositoryEnvironmentConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	RepositoryEnvironmentConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: RepositoryEnvironmentConfig

---

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".
putDeploymentBranchPolicy	No description.
putReviewers	No description.
resetCanAdminsBypass	No description.
resetDeploymentBranchPolicy	No description.
resetId	No description.
resetPreventSelfReview	No description.
resetReviewers	No description.
resetWaitTimer	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

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

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

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

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

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

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

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

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

id^Required

• Type: string

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

---

moveTo

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

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

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

---

index^Optional

• Type: string | number

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

---

moveToId

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

id^Required

• Type: string

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

---

putDeploymentBranchPolicy

public putDeploymentBranchPolicy(value: RepositoryEnvironmentDeploymentBranchPolicy): void

value^Required

• Type: RepositoryEnvironmentDeploymentBranchPolicy

---

putReviewers

public putReviewers(value: IResolvable | RepositoryEnvironmentReviewers[]): void

value^Required

• Type: cdktf.IResolvable | RepositoryEnvironmentReviewers[]

---

resetCanAdminsBypass

public resetCanAdminsBypass(): void

resetDeploymentBranchPolicy

public resetDeploymentBranchPolicy(): void

resetId

public resetId(): void

resetPreventSelfReview

public resetPreventSelfReview(): void

resetReviewers

public resetReviewers(): void

resetWaitTimer

public resetWaitTimer(): 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 RepositoryEnvironment resource upon running "cdktf plan ".

---

isConstruct

import { repositoryEnvironment } from '@cdktf/provider-github'

repositoryEnvironment.RepositoryEnvironment.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { repositoryEnvironment } from '@cdktf/provider-github'

repositoryEnvironment.RepositoryEnvironment.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { repositoryEnvironment } from '@cdktf/provider-github'

repositoryEnvironment.RepositoryEnvironment.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { repositoryEnvironment } from '@cdktf/provider-github'

repositoryEnvironment.RepositoryEnvironment.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

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

---

importFromId^Required

• Type: string

The id of the existing RepositoryEnvironment that should be imported.

Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/repository_environment#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the RepositoryEnvironment 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.
deploymentBranchPolicy	RepositoryEnvironmentDeploymentBranchPolicyOutputReference	No description.
reviewers	RepositoryEnvironmentReviewersList	No description.
canAdminsBypassInput	boolean | cdktf.IResolvable	No description.
deploymentBranchPolicyInput	RepositoryEnvironmentDeploymentBranchPolicy	No description.
environmentInput	string	No description.
idInput	string	No description.
preventSelfReviewInput	boolean | cdktf.IResolvable	No description.
repositoryInput	string	No description.
reviewersInput	cdktf.IResolvable | RepositoryEnvironmentReviewers[]	No description.
waitTimerInput	number	No description.
canAdminsBypass	boolean | cdktf.IResolvable	No description.
environment	string	No description.
id	string	No description.
preventSelfReview	boolean | cdktf.IResolvable	No description.
repository	string	No description.
waitTimer	number	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

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

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

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

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

---

deploymentBranchPolicy^Required

public readonly deploymentBranchPolicy: RepositoryEnvironmentDeploymentBranchPolicyOutputReference;

• Type: RepositoryEnvironmentDeploymentBranchPolicyOutputReference

---

reviewers^Required

public readonly reviewers: RepositoryEnvironmentReviewersList;

• Type: RepositoryEnvironmentReviewersList

---

canAdminsBypassInput^Optional

public readonly canAdminsBypassInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

deploymentBranchPolicyInput^Optional

public readonly deploymentBranchPolicyInput: RepositoryEnvironmentDeploymentBranchPolicy;

• Type: RepositoryEnvironmentDeploymentBranchPolicy

---

environmentInput^Optional

public readonly environmentInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

preventSelfReviewInput^Optional

public readonly preventSelfReviewInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

repositoryInput^Optional

public readonly repositoryInput: string;

• Type: string

---

reviewersInput^Optional

public readonly reviewersInput: IResolvable | RepositoryEnvironmentReviewers[];

• Type: cdktf.IResolvable | RepositoryEnvironmentReviewers[]

---

waitTimerInput^Optional

public readonly waitTimerInput: number;

• Type: number

---

canAdminsBypass^Required

public readonly canAdminsBypass: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

environment^Required

public readonly environment: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

preventSelfReview^Required

public readonly preventSelfReview: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

repository^Required

public readonly repository: string;

• Type: string

---

waitTimer^Required

public readonly waitTimer: number;

• Type: number

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

RepositoryEnvironmentConfig

Initializer

import { repositoryEnvironment } from '@cdktf/provider-github'

const repositoryEnvironmentConfig: repositoryEnvironment.RepositoryEnvironmentConfig = { ... }

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.
repository	string	The repository of the environment.
canAdminsBypass	boolean | cdktf.IResolvable	Can Admins bypass deployment protections.
deploymentBranchPolicy	RepositoryEnvironmentDeploymentBranchPolicy	deployment_branch_policy block.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/repository_environment#id RepositoryEnvironment#id}.
preventSelfReview	boolean | cdktf.IResolvable	Prevent users from approving workflows runs that they triggered.
reviewers	cdktf.IResolvable | RepositoryEnvironmentReviewers[]	reviewers block.
waitTimer	number	Amount of time to delay a job after the job is initially triggered.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

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

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

---

environment^Required

public readonly environment: string;

• Type: string

The name of the environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/repository_environment#environment RepositoryEnvironment#environment}

---

repository^Required

public readonly repository: string;

• Type: string

The repository of the environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/repository_environment#repository RepositoryEnvironment#repository}

---

canAdminsBypass^Optional

public readonly canAdminsBypass: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Can Admins bypass deployment protections.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/repository_environment#can_admins_bypass RepositoryEnvironment#can_admins_bypass}

---

deploymentBranchPolicy^Optional

public readonly deploymentBranchPolicy: RepositoryEnvironmentDeploymentBranchPolicy;

• Type: RepositoryEnvironmentDeploymentBranchPolicy

deployment_branch_policy block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/repository_environment#deployment_branch_policy RepositoryEnvironment#deployment_branch_policy}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/repository_environment#id RepositoryEnvironment#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.

---

preventSelfReview^Optional

public readonly preventSelfReview: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Prevent users from approving workflows runs that they triggered.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/repository_environment#prevent_self_review RepositoryEnvironment#prevent_self_review}

---

reviewers^Optional

public readonly reviewers: IResolvable | RepositoryEnvironmentReviewers[];

• Type: cdktf.IResolvable | RepositoryEnvironmentReviewers[]

reviewers block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/repository_environment#reviewers RepositoryEnvironment#reviewers}

---

waitTimer^Optional

public readonly waitTimer: number;

• Type: number

Amount of time to delay a job after the job is initially triggered.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/repository_environment#wait_timer RepositoryEnvironment#wait_timer}

---

RepositoryEnvironmentDeploymentBranchPolicy

Initializer

import { repositoryEnvironment } from '@cdktf/provider-github'

const repositoryEnvironmentDeploymentBranchPolicy: repositoryEnvironment.RepositoryEnvironmentDeploymentBranchPolicy = { ... }

Properties

Name	Type	Description
customBranchPolicies	boolean | cdktf.IResolvable	Whether only branches that match the specified name patterns can deploy to this environment.
protectedBranches	boolean | cdktf.IResolvable	Whether only branches with branch protection rules can deploy to this environment.

---

customBranchPolicies^Required

public readonly customBranchPolicies: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Whether only branches that match the specified name patterns can deploy to this environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/repository_environment#custom_branch_policies RepositoryEnvironment#custom_branch_policies}

---

protectedBranches^Required

public readonly protectedBranches: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Whether only branches with branch protection rules can deploy to this environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/repository_environment#protected_branches RepositoryEnvironment#protected_branches}

---

RepositoryEnvironmentReviewers

Initializer

import { repositoryEnvironment } from '@cdktf/provider-github'

const repositoryEnvironmentReviewers: repositoryEnvironment.RepositoryEnvironmentReviewers = { ... }

Properties

Name	Type	Description
teams	number[]	Up to 6 IDs for teams who may review jobs that reference the environment.
users	number[]	Up to 6 IDs for users who may review jobs that reference the environment.

---

teams^Optional

public readonly teams: number[];

• Type: number[]

Up to 6 IDs for teams who may review jobs that reference the environment.

Reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/repository_environment#teams RepositoryEnvironment#teams}

---

users^Optional

public readonly users: number[];

• Type: number[]

Up to 6 IDs for users who may review jobs that reference the environment.

Reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/repository_environment#users RepositoryEnvironment#users}

---

Classes

RepositoryEnvironmentDeploymentBranchPolicyOutputReference

Initializers

import { repositoryEnvironment } from '@cdktf/provider-github'

new repositoryEnvironment.RepositoryEnvironmentDeploymentBranchPolicyOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

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

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

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

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

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

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

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

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
customBranchPoliciesInput	boolean | cdktf.IResolvable	No description.
protectedBranchesInput	boolean | cdktf.IResolvable	No description.
customBranchPolicies	boolean | cdktf.IResolvable	No description.
protectedBranches	boolean | cdktf.IResolvable	No description.
internalValue	RepositoryEnvironmentDeploymentBranchPolicy	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

customBranchPoliciesInput^Optional

public readonly customBranchPoliciesInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

protectedBranchesInput^Optional

public readonly protectedBranchesInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

customBranchPolicies^Required

public readonly customBranchPolicies: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

protectedBranches^Required

public readonly protectedBranches: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

internalValue^Optional

public readonly internalValue: RepositoryEnvironmentDeploymentBranchPolicy;

• Type: RepositoryEnvironmentDeploymentBranchPolicy

---

RepositoryEnvironmentReviewersList

Initializers

import { repositoryEnvironment } from '@cdktf/provider-github'

new repositoryEnvironment.RepositoryEnvironmentReviewersList(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).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

wrapsSet^Required

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

mapKeyAttributeName^Required

• Type: string

---

computeFqn

public computeFqn(): string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get

public get(index: number): RepositoryEnvironmentReviewersOutputReference

index^Required

• 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 | RepositoryEnvironmentReviewers[]	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | RepositoryEnvironmentReviewers[];

• Type: cdktf.IResolvable | RepositoryEnvironmentReviewers[]

---

RepositoryEnvironmentReviewersOutputReference

Initializers

import { repositoryEnvironment } from '@cdktf/provider-github'

new repositoryEnvironment.RepositoryEnvironmentReviewersOutputReference(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).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

complexObjectIndex^Required

• Type: number

the index of this item in the list.

---

complexObjectIsFromSet^Required

• 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.
resetTeams	No description.
resetUsers	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

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

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

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

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

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

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetTeams

public resetTeams(): void

resetUsers

public resetUsers(): 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.
teamsInput	number[]	No description.
usersInput	number[]	No description.
teams	number[]	No description.
users	number[]	No description.
internalValue	cdktf.IResolvable | RepositoryEnvironmentReviewers	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

teamsInput^Optional

public readonly teamsInput: number[];

• Type: number[]

---

usersInput^Optional

public readonly usersInput: number[];

• Type: number[]

---

teams^Required

public readonly teams: number[];

• Type: number[]

---

users^Required

public readonly users: number[];

• Type: number[]

---

internalValue^Optional

public readonly internalValue: IResolvable | RepositoryEnvironmentReviewers;

• Type: cdktf.IResolvable | RepositoryEnvironmentReviewers

---