Skip to content

Latest commit

 

History

History
2189 lines (1356 loc) · 108 KB

repositoryEnvironment.java.md

File metadata and controls

2189 lines (1356 loc) · 108 KB
Raw

repositoryEnvironment Submodule

Constructs

RepositoryEnvironment

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

Initializers 

import com.hashicorp.cdktf.providers.github.repository_environment.RepositoryEnvironment;

RepositoryEnvironment.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .environment(java.lang.String)
    .repository(java.lang.String)
//  .canAdminsBypass(java.lang.Boolean)
//  .canAdminsBypass(IResolvable)
//  .deploymentBranchPolicy(RepositoryEnvironmentDeploymentBranchPolicy)
//  .id(java.lang.String)
//  .preventSelfReview(java.lang.Boolean)
//  .preventSelfReview(IResolvable)
//  .reviewers(IResolvable)
//  .reviewers(java.util.List<RepositoryEnvironmentReviewers>)
//  .waitTimer(java.lang.Number)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
environment java.lang.String The name of the environment.
repository java.lang.String The repository of the environment.
canAdminsBypass java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Can Admins bypass deployment protections.
deploymentBranchPolicy RepositoryEnvironmentDeploymentBranchPolicy deployment_branch_policy block.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_environment#id RepositoryEnvironment#id}.
preventSelfReview java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Prevent users from approving workflows runs that they triggered.
reviewers com.hashicorp.cdktf.IResolvable OR java.util.List<RepositoryEnvironmentReviewers> reviewers block.
waitTimer java.lang.Number Amount of time to delay a job after the job is initially triggered.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
environmentRequired
  • Type: java.lang.String

The name of the environment.

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

repositoryRequired
  • Type: java.lang.String

The repository of the environment.

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

canAdminsBypassOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Can Admins bypass deployment protections.

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

deploymentBranchPolicyOptional

deployment_branch_policy block.

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

idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.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.

preventSelfReviewOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Prevent users from approving workflows runs that they triggered.

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

reviewersOptional

reviewers block.

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

waitTimerOptional
  • Type: java.lang.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.4.0/docs/resources/repository_environment#wait_timer RepositoryEnvironment#wait_timer}

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 java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

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: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

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: java.lang.String

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

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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

indexOptional
  • Type: java.lang.String OR java.lang.Number

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

moveToId 
public void moveToId(java.lang.String id)

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

idRequired
  • Type: java.lang.String

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

putDeploymentBranchPolicy 
public void putDeploymentBranchPolicy(RepositoryEnvironmentDeploymentBranchPolicy value)
valueRequired
putReviewers 
public void putReviewers(IResolvable OR java.util.List<RepositoryEnvironmentReviewers> value)
valueRequired
resetCanAdminsBypass 
public void resetCanAdminsBypass()
resetDeploymentBranchPolicy 
public void resetDeploymentBranchPolicy()
resetId 
public void resetId()
resetPreventSelfReview 
public void resetPreventSelfReview()
resetReviewers 
public void resetReviewers()
resetWaitTimer 
public void resetWaitTimer()

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 com.hashicorp.cdktf.providers.github.repository_environment.RepositoryEnvironment;

RepositoryEnvironment.isConstruct(java.lang.Object x)

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: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.github.repository_environment.RepositoryEnvironment;

RepositoryEnvironment.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.github.repository_environment.RepositoryEnvironment;

RepositoryEnvironment.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.github.repository_environment.RepositoryEnvironment;

RepositoryEnvironment.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),RepositoryEnvironment.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing RepositoryEnvironment that should be imported.

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

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

? Optional instance of the provider where the RepositoryEnvironment to import is found.

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
deploymentBranchPolicy RepositoryEnvironmentDeploymentBranchPolicyOutputReference No description.
reviewers RepositoryEnvironmentReviewersList No description.
canAdminsBypassInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
deploymentBranchPolicyInput RepositoryEnvironmentDeploymentBranchPolicy No description.
environmentInput java.lang.String No description.
idInput java.lang.String No description.
preventSelfReviewInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
repositoryInput java.lang.String No description.
reviewersInput com.hashicorp.cdktf.IResolvable OR java.util.List<RepositoryEnvironmentReviewers> No description.
waitTimerInput java.lang.Number No description.
canAdminsBypass java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
environment java.lang.String No description.
id java.lang.String No description.
preventSelfReview java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
repository java.lang.String No description.
waitTimer java.lang.Number No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
deploymentBranchPolicyRequired 
public RepositoryEnvironmentDeploymentBranchPolicyOutputReference getDeploymentBranchPolicy();
reviewersRequired 
public RepositoryEnvironmentReviewersList getReviewers();
canAdminsBypassInputOptional 
public java.lang.Object getCanAdminsBypassInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
deploymentBranchPolicyInputOptional 
public RepositoryEnvironmentDeploymentBranchPolicy getDeploymentBranchPolicyInput();
environmentInputOptional 
public java.lang.String getEnvironmentInput();
  • Type: java.lang.String
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
preventSelfReviewInputOptional 
public java.lang.Object getPreventSelfReviewInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
repositoryInputOptional 
public java.lang.String getRepositoryInput();
  • Type: java.lang.String
reviewersInputOptional 
public java.lang.Object getReviewersInput();
waitTimerInputOptional 
public java.lang.Number getWaitTimerInput();
  • Type: java.lang.Number
canAdminsBypassRequired 
public java.lang.Object getCanAdminsBypass();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
environmentRequired 
public java.lang.String getEnvironment();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
preventSelfReviewRequired 
public java.lang.Object getPreventSelfReview();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
repositoryRequired 
public java.lang.String getRepository();
  • Type: java.lang.String
waitTimerRequired 
public java.lang.Number getWaitTimer();
  • Type: java.lang.Number

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

RepositoryEnvironmentConfig

Initializer 

import com.hashicorp.cdktf.providers.github.repository_environment.RepositoryEnvironmentConfig;

RepositoryEnvironmentConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .environment(java.lang.String)
    .repository(java.lang.String)
//  .canAdminsBypass(java.lang.Boolean)
//  .canAdminsBypass(IResolvable)
//  .deploymentBranchPolicy(RepositoryEnvironmentDeploymentBranchPolicy)
//  .id(java.lang.String)
//  .preventSelfReview(java.lang.Boolean)
//  .preventSelfReview(IResolvable)
//  .reviewers(IResolvable)
//  .reviewers(java.util.List<RepositoryEnvironmentReviewers>)
//  .waitTimer(java.lang.Number)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
environment java.lang.String The name of the environment.
repository java.lang.String The repository of the environment.
canAdminsBypass java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Can Admins bypass deployment protections.
deploymentBranchPolicy RepositoryEnvironmentDeploymentBranchPolicy deployment_branch_policy block.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_environment#id RepositoryEnvironment#id}.
preventSelfReview java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Prevent users from approving workflows runs that they triggered.
reviewers com.hashicorp.cdktf.IResolvable OR java.util.List<RepositoryEnvironmentReviewers> reviewers block.
waitTimer java.lang.Number Amount of time to delay a job after the job is initially triggered.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
environmentRequired 
public java.lang.String getEnvironment();
  • Type: java.lang.String

The name of the environment.

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

repositoryRequired 
public java.lang.String getRepository();
  • Type: java.lang.String

The repository of the environment.

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

canAdminsBypassOptional 
public java.lang.Object getCanAdminsBypass();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Can Admins bypass deployment protections.

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

deploymentBranchPolicyOptional 
public RepositoryEnvironmentDeploymentBranchPolicy getDeploymentBranchPolicy();

deployment_branch_policy block.

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

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.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.

preventSelfReviewOptional 
public java.lang.Object getPreventSelfReview();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Prevent users from approving workflows runs that they triggered.

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

reviewersOptional 
public java.lang.Object getReviewers();

reviewers block.

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

waitTimerOptional 
public java.lang.Number getWaitTimer();
  • Type: java.lang.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.4.0/docs/resources/repository_environment#wait_timer RepositoryEnvironment#wait_timer}

RepositoryEnvironmentDeploymentBranchPolicy

Initializer 

import com.hashicorp.cdktf.providers.github.repository_environment.RepositoryEnvironmentDeploymentBranchPolicy;

RepositoryEnvironmentDeploymentBranchPolicy.builder()
    .customBranchPolicies(java.lang.Boolean)
    .customBranchPolicies(IResolvable)
    .protectedBranches(java.lang.Boolean)
    .protectedBranches(IResolvable)
    .build();

Properties

Name Type Description
customBranchPolicies java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether only branches that match the specified name patterns can deploy to this environment.
protectedBranches java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether only branches with branch protection rules can deploy to this environment.
customBranchPoliciesRequired 
public java.lang.Object getCustomBranchPolicies();
  • Type: java.lang.Boolean OR com.hashicorp.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.4.0/docs/resources/repository_environment#custom_branch_policies RepositoryEnvironment#custom_branch_policies}

protectedBranchesRequired 
public java.lang.Object getProtectedBranches();
  • Type: java.lang.Boolean OR com.hashicorp.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.4.0/docs/resources/repository_environment#protected_branches RepositoryEnvironment#protected_branches}

RepositoryEnvironmentReviewers

Initializer 

import com.hashicorp.cdktf.providers.github.repository_environment.RepositoryEnvironmentReviewers;

RepositoryEnvironmentReviewers.builder()
//  .teams(java.util.List<java.lang.Number>)
//  .users(java.util.List<java.lang.Number>)
    .build();

Properties

Name Type Description
teams java.util.List<java.lang.Number> Up to 6 IDs for teams who may review jobs that reference the environment.
users java.util.List<java.lang.Number> Up to 6 IDs for users who may review jobs that reference the environment.
teamsOptional 
public java.util.List<java.lang.Number> getTeams();
  • Type: java.util.List<java.lang.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.4.0/docs/resources/repository_environment#teams RepositoryEnvironment#teams}

usersOptional 
public java.util.List<java.lang.Number> getUsers();
  • Type: java.util.List<java.lang.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.4.0/docs/resources/repository_environment#users RepositoryEnvironment#users}

Classes

RepositoryEnvironmentDeploymentBranchPolicyOutputReference

Initializers 

import com.hashicorp.cdktf.providers.github.repository_environment.RepositoryEnvironmentDeploymentBranchPolicyOutputReference;

new RepositoryEnvironmentDeploymentBranchPolicyOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.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 java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
customBranchPoliciesInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
protectedBranchesInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
customBranchPolicies java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
protectedBranches java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
internalValue RepositoryEnvironmentDeploymentBranchPolicy No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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 java.lang.String getFqn();
  • Type: java.lang.String
customBranchPoliciesInputOptional 
public java.lang.Object getCustomBranchPoliciesInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
protectedBranchesInputOptional 
public java.lang.Object getProtectedBranchesInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
customBranchPoliciesRequired 
public java.lang.Object getCustomBranchPolicies();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
protectedBranchesRequired 
public java.lang.Object getProtectedBranches();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
internalValueOptional 
public RepositoryEnvironmentDeploymentBranchPolicy getInternalValue();

RepositoryEnvironmentReviewersList

Initializers 

import com.hashicorp.cdktf.providers.github.repository_environment.RepositoryEnvironmentReviewersList;

new RepositoryEnvironmentReviewersList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
wrapsSet java.lang.Boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: java.lang.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 DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName)

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: java.lang.String
computeFqn 
public java.lang.String computeFqn()
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
public RepositoryEnvironmentReviewersOutputReference get(java.lang.Number index)
indexRequired
  • Type: java.lang.Number

the index of the item to return.

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR java.util.List<RepositoryEnvironmentReviewers> No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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 java.lang.String getFqn();
  • Type: java.lang.String
internalValueOptional 
public java.lang.Object getInternalValue();

RepositoryEnvironmentReviewersOutputReference

Initializers 

import com.hashicorp.cdktf.providers.github.repository_environment.RepositoryEnvironmentReviewersOutputReference;

new RepositoryEnvironmentReviewersOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
complexObjectIndex java.lang.Number the index of this item in the list.
complexObjectIsFromSet java.lang.Boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: java.lang.Number

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: java.lang.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 java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetTeams 
public void resetTeams()
resetUsers 
public void resetUsers()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
teamsInput java.util.List<java.lang.Number> No description.
usersInput java.util.List<java.lang.Number> No description.
teams java.util.List<java.lang.Number> No description.
users java.util.List<java.lang.Number> No description.
internalValue com.hashicorp.cdktf.IResolvable OR RepositoryEnvironmentReviewers No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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 java.lang.String getFqn();
  • Type: java.lang.String
teamsInputOptional 
public java.util.List<java.lang.Number> getTeamsInput();
  • Type: java.util.List<java.lang.Number>
usersInputOptional 
public java.util.List<java.lang.Number> getUsersInput();
  • Type: java.util.List<java.lang.Number>
teamsRequired 
public java.util.List<java.lang.Number> getTeams();
  • Type: java.util.List<java.lang.Number>
usersRequired 
public java.util.List<java.lang.Number> getUsers();
  • Type: java.util.List<java.lang.Number>
internalValueOptional 
public java.lang.Object getInternalValue();