Represents a {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection github_branch_protection}.
using HashiCorp.Cdktf.Providers.Github;
new BranchProtection(Construct Scope, string Id, BranchProtectionConfig Config);
Name | Type | Description |
---|---|---|
Scope |
Constructs.Construct |
The scope in which to define this construct. |
Id |
string |
The scoped construct ID. |
Config |
BranchProtectionConfig |
No description. |
- Type: Constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: BranchProtectionConfig
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". |
PutRequiredPullRequestReviews |
No description. |
PutRequiredStatusChecks |
No description. |
PutRestrictPushes |
No description. |
ResetAllowsDeletions |
No description. |
ResetAllowsForcePushes |
No description. |
ResetEnforceAdmins |
No description. |
ResetForcePushBypassers |
No description. |
ResetId |
No description. |
ResetLockBranch |
No description. |
ResetRequireConversationResolution |
No description. |
ResetRequiredLinearHistory |
No description. |
ResetRequiredPullRequestReviews |
No description. |
ResetRequiredStatusChecks |
No description. |
ResetRequireSignedCommits |
No description. |
ResetRestrictPushes |
No description. |
private string ToString()
Returns a string representation of this construct.
private void AddOverride(string Path, object Value)
- Type: string
- Type: object
private void OverrideLogicalId(string NewLogicalId)
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
private object ToHclTerraform()
private object ToMetadata()
private object ToTerraform()
Adds this resource to the terraform JSON output.
private void AddMoveTarget(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.
- Type: string
The string move target that will correspond to this resource.
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
- Type: string
private IResolvable GetBooleanAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
- Type: string
private string[] GetListAttribute(string TerraformAttribute)
- Type: string
private double GetNumberAttribute(string TerraformAttribute)
- Type: string
private double[] GetNumberListAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
- Type: string
private string GetStringAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
- Type: string
private object HasResourceMove()
private void ImportFrom(string Id, TerraformProvider Provider = null)
- Type: string
- Type: HashiCorp.Cdktf.TerraformProvider
private IResolvable InterpolationForAttribute(string TerraformAttribute)
- Type: string
private void MoveFromId(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.
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
private void MoveTo(string MoveTarget, object Index = null)
Moves this resource to the target resource given by moveTarget.
- Type: string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: object
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
private void MoveToId(string Id)
Moves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
private void PutRequiredPullRequestReviews(object Value)
- Type: object
private void PutRequiredStatusChecks(object Value)
- Type: object
private void PutRestrictPushes(object Value)
- Type: object
private void ResetAllowsDeletions()
private void ResetAllowsForcePushes()
private void ResetEnforceAdmins()
private void ResetForcePushBypassers()
private void ResetId()
private void ResetLockBranch()
private void ResetRequireConversationResolution()
private void ResetRequiredLinearHistory()
private void ResetRequiredPullRequestReviews()
private void ResetRequiredStatusChecks()
private void ResetRequireSignedCommits()
private void ResetRestrictPushes()
Name | Description |
---|---|
IsConstruct |
Checks if x is a construct. |
IsTerraformElement |
No description. |
IsTerraformResource |
No description. |
GenerateConfigForImport |
Generates CDKTF code for importing a BranchProtection resource upon running "cdktf plan ". |
using HashiCorp.Cdktf.Providers.Github;
BranchProtection.IsConstruct(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.
- Type: object
Any object.
using HashiCorp.Cdktf.Providers.Github;
BranchProtection.IsTerraformElement(object X);
- Type: object
using HashiCorp.Cdktf.Providers.Github;
BranchProtection.IsTerraformResource(object X);
- Type: object
using HashiCorp.Cdktf.Providers.Github;
BranchProtection.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);
Generates CDKTF code for importing a BranchProtection resource upon running "cdktf plan ".
- Type: Constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the BranchProtection to import.
- Type: string
The id of the existing BranchProtection that should be imported.
Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#import import section} in the documentation of this resource for the id to use
- Type: HashiCorp.Cdktf.TerraformProvider
? Optional instance of the provider where the BranchProtection to import is found.
Name | Type | Description |
---|---|---|
Node |
Constructs.Node |
The tree node. |
CdktfStack |
HashiCorp.Cdktf.TerraformStack |
No description. |
Fqn |
string |
No description. |
FriendlyUniqueId |
string |
No description. |
TerraformMetaArguments |
System.Collections.Generic.IDictionary<string, object> |
No description. |
TerraformResourceType |
string |
No description. |
TerraformGeneratorMetadata |
HashiCorp.Cdktf.TerraformProviderGeneratorMetadata |
No description. |
Connection |
object |
No description. |
Count |
object |
No description. |
DependsOn |
string[] |
No description. |
ForEach |
HashiCorp.Cdktf.ITerraformIterator |
No description. |
Lifecycle |
HashiCorp.Cdktf.TerraformResourceLifecycle |
No description. |
Provider |
HashiCorp.Cdktf.TerraformProvider |
No description. |
Provisioners |
object[] |
No description. |
RequiredPullRequestReviews |
BranchProtectionRequiredPullRequestReviewsList |
No description. |
RequiredStatusChecks |
BranchProtectionRequiredStatusChecksList |
No description. |
RestrictPushes |
BranchProtectionRestrictPushesList |
No description. |
AllowsDeletionsInput |
object |
No description. |
AllowsForcePushesInput |
object |
No description. |
EnforceAdminsInput |
object |
No description. |
ForcePushBypassersInput |
string[] |
No description. |
IdInput |
string |
No description. |
LockBranchInput |
object |
No description. |
PatternInput |
string |
No description. |
RepositoryIdInput |
string |
No description. |
RequireConversationResolutionInput |
object |
No description. |
RequiredLinearHistoryInput |
object |
No description. |
RequiredPullRequestReviewsInput |
object |
No description. |
RequiredStatusChecksInput |
object |
No description. |
RequireSignedCommitsInput |
object |
No description. |
RestrictPushesInput |
object |
No description. |
AllowsDeletions |
object |
No description. |
AllowsForcePushes |
object |
No description. |
EnforceAdmins |
object |
No description. |
ForcePushBypassers |
string[] |
No description. |
Id |
string |
No description. |
LockBranch |
object |
No description. |
Pattern |
string |
No description. |
RepositoryId |
string |
No description. |
RequireConversationResolution |
object |
No description. |
RequiredLinearHistory |
object |
No description. |
RequireSignedCommits |
object |
No description. |
public Node Node { get; }
- Type: Constructs.Node
The tree node.
public TerraformStack CdktfStack { get; }
- Type: HashiCorp.Cdktf.TerraformStack
public string Fqn { get; }
- Type: string
public string FriendlyUniqueId { get; }
- Type: string
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
- Type: System.Collections.Generic.IDictionary<string, object>
public string TerraformResourceType { get; }
- Type: string
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
- Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
public object Connection { get; }
- Type: object
public object Count { get; }
- Type: object
public string[] DependsOn { get; }
- Type: string[]
public ITerraformIterator ForEach { get; }
- Type: HashiCorp.Cdktf.ITerraformIterator
public TerraformResourceLifecycle Lifecycle { get; }
- Type: HashiCorp.Cdktf.TerraformResourceLifecycle
public TerraformProvider Provider { get; }
- Type: HashiCorp.Cdktf.TerraformProvider
public object[] Provisioners { get; }
- Type: object[]
public BranchProtectionRequiredPullRequestReviewsList RequiredPullRequestReviews { get; }
public BranchProtectionRequiredStatusChecksList RequiredStatusChecks { get; }
public BranchProtectionRestrictPushesList RestrictPushes { get; }
public object AllowsDeletionsInput { get; }
- Type: object
public object AllowsForcePushesInput { get; }
- Type: object
public object EnforceAdminsInput { get; }
- Type: object
public string[] ForcePushBypassersInput { get; }
- Type: string[]
public string IdInput { get; }
- Type: string
public object LockBranchInput { get; }
- Type: object
public string PatternInput { get; }
- Type: string
public string RepositoryIdInput { get; }
- Type: string
public object RequireConversationResolutionInput { get; }
- Type: object
public object RequiredLinearHistoryInput { get; }
- Type: object
public object RequiredPullRequestReviewsInput { get; }
- Type: object
public object RequiredStatusChecksInput { get; }
- Type: object
public object RequireSignedCommitsInput { get; }
- Type: object
public object RestrictPushesInput { get; }
- Type: object
public object AllowsDeletions { get; }
- Type: object
public object AllowsForcePushes { get; }
- Type: object
public object EnforceAdmins { get; }
- Type: object
public string[] ForcePushBypassers { get; }
- Type: string[]
public string Id { get; }
- Type: string
public object LockBranch { get; }
- Type: object
public string Pattern { get; }
- Type: string
public string RepositoryId { get; }
- Type: string
public object RequireConversationResolution { get; }
- Type: object
public object RequiredLinearHistory { get; }
- Type: object
public object RequireSignedCommits { get; }
- Type: object
Name | Type | Description |
---|---|---|
TfResourceType |
string |
No description. |
public string TfResourceType { get; }
- Type: string
using HashiCorp.Cdktf.Providers.Github;
new BranchProtectionConfig {
object Connection = null,
object Count = null,
ITerraformDependable[] DependsOn = null,
ITerraformIterator ForEach = null,
TerraformResourceLifecycle Lifecycle = null,
TerraformProvider Provider = null,
object[] Provisioners = null,
string Pattern,
string RepositoryId,
object AllowsDeletions = null,
object AllowsForcePushes = null,
object EnforceAdmins = null,
string[] ForcePushBypassers = null,
string Id = null,
object LockBranch = null,
object RequireConversationResolution = null,
object RequiredLinearHistory = null,
object RequiredPullRequestReviews = null,
object RequiredStatusChecks = null,
object RequireSignedCommits = null,
object RestrictPushes = null
};
Name | Type | Description |
---|---|---|
Connection |
object |
No description. |
Count |
object |
No description. |
DependsOn |
HashiCorp.Cdktf.ITerraformDependable[] |
No description. |
ForEach |
HashiCorp.Cdktf.ITerraformIterator |
No description. |
Lifecycle |
HashiCorp.Cdktf.TerraformResourceLifecycle |
No description. |
Provider |
HashiCorp.Cdktf.TerraformProvider |
No description. |
Provisioners |
object[] |
No description. |
Pattern |
string |
Identifies the protection rule pattern. |
RepositoryId |
string |
The name or node ID of the repository associated with this branch protection rule. |
AllowsDeletions |
object |
Setting this to 'true' to allow the branch to be deleted. |
AllowsForcePushes |
object |
Setting this to 'true' to allow force pushes on the branch. |
EnforceAdmins |
object |
Setting this to 'true' enforces status checks for repository administrators. |
ForcePushBypassers |
string[] |
The list of actor Names/IDs that are allowed to bypass force push restrictions. |
Id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#id BranchProtection#id}. |
LockBranch |
object |
Setting this to 'true' will make the branch read-only and preventing any pushes to it. |
RequireConversationResolution |
object |
Setting this to 'true' requires all conversations on code must be resolved before a pull request can be merged. |
RequiredLinearHistory |
object |
Setting this to 'true' enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. |
RequiredPullRequestReviews |
object |
required_pull_request_reviews block. |
RequiredStatusChecks |
object |
required_status_checks block. |
RequireSignedCommits |
object |
Setting this to 'true' requires all commits to be signed with GPG. |
RestrictPushes |
object |
restrict_pushes block. |
public object Connection { get; set; }
- Type: object
public object Count { get; set; }
- Type: object
public ITerraformDependable[] DependsOn { get; set; }
- Type: HashiCorp.Cdktf.ITerraformDependable[]
public ITerraformIterator ForEach { get; set; }
- Type: HashiCorp.Cdktf.ITerraformIterator
public TerraformResourceLifecycle Lifecycle { get; set; }
- Type: HashiCorp.Cdktf.TerraformResourceLifecycle
public TerraformProvider Provider { get; set; }
- Type: HashiCorp.Cdktf.TerraformProvider
public object[] Provisioners { get; set; }
- Type: object[]
public string Pattern { get; set; }
- Type: string
Identifies the protection rule pattern.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#pattern BranchProtection#pattern}
public string RepositoryId { get; set; }
- Type: string
The name or node ID of the repository associated with this branch protection rule.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#repository_id BranchProtection#repository_id}
public object AllowsDeletions { get; set; }
- Type: object
Setting this to 'true' to allow the branch to be deleted.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#allows_deletions BranchProtection#allows_deletions}
public object AllowsForcePushes { get; set; }
- Type: object
Setting this to 'true' to allow force pushes on the branch.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#allows_force_pushes BranchProtection#allows_force_pushes}
public object EnforceAdmins { get; set; }
- Type: object
Setting this to 'true' enforces status checks for repository administrators.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#enforce_admins BranchProtection#enforce_admins}
public string[] ForcePushBypassers { get; set; }
- Type: string[]
The list of actor Names/IDs that are allowed to bypass force push restrictions.
Actor names must either begin with a '/' for users or the organization name followed by a '/' for teams.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#force_push_bypassers BranchProtection#force_push_bypassers}
public string Id { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#id BranchProtection#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.
public object LockBranch { get; set; }
- Type: object
Setting this to 'true' will make the branch read-only and preventing any pushes to it.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#lock_branch BranchProtection#lock_branch}
public object RequireConversationResolution { get; set; }
- Type: object
Setting this to 'true' requires all conversations on code must be resolved before a pull request can be merged.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#require_conversation_resolution BranchProtection#require_conversation_resolution}
public object RequiredLinearHistory { get; set; }
- Type: object
Setting this to 'true' enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#required_linear_history BranchProtection#required_linear_history}
public object RequiredPullRequestReviews { get; set; }
- Type: object
required_pull_request_reviews block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#required_pull_request_reviews BranchProtection#required_pull_request_reviews}
public object RequiredStatusChecks { get; set; }
- Type: object
required_status_checks block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#required_status_checks BranchProtection#required_status_checks}
public object RequireSignedCommits { get; set; }
- Type: object
Setting this to 'true' requires all commits to be signed with GPG.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#require_signed_commits BranchProtection#require_signed_commits}
public object RestrictPushes { get; set; }
- Type: object
restrict_pushes block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#restrict_pushes BranchProtection#restrict_pushes}
using HashiCorp.Cdktf.Providers.Github;
new BranchProtectionRequiredPullRequestReviews {
string[] DismissalRestrictions = null,
object DismissStaleReviews = null,
string[] PullRequestBypassers = null,
object RequireCodeOwnerReviews = null,
double RequiredApprovingReviewCount = null,
object RequireLastPushApproval = null,
object RestrictDismissals = null
};
Name | Type | Description |
---|---|---|
DismissalRestrictions |
string[] |
The list of actor Names/IDs with dismissal access. |
DismissStaleReviews |
object |
Dismiss approved reviews automatically when a new commit is pushed. |
PullRequestBypassers |
string[] |
The list of actor Names/IDs that are allowed to bypass pull request requirements. |
RequireCodeOwnerReviews |
object |
Require an approved review in pull requests including files with a designated code owner. |
RequiredApprovingReviewCount |
double |
Require 'x' number of approvals to satisfy branch protection requirements. |
RequireLastPushApproval |
object |
Require that The most recent push must be approved by someone other than the last pusher. |
RestrictDismissals |
object |
Restrict pull request review dismissals. |
public string[] DismissalRestrictions { get; set; }
- Type: string[]
The list of actor Names/IDs with dismissal access.
If not empty, 'restrict_dismissals' is ignored. Actor names must either begin with a '/' for users or the organization name followed by a '/' for teams.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#dismissal_restrictions BranchProtection#dismissal_restrictions}
public object DismissStaleReviews { get; set; }
- Type: object
Dismiss approved reviews automatically when a new commit is pushed.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#dismiss_stale_reviews BranchProtection#dismiss_stale_reviews}
public string[] PullRequestBypassers { get; set; }
- Type: string[]
The list of actor Names/IDs that are allowed to bypass pull request requirements.
Actor names must either begin with a '/' for users or the organization name followed by a '/' for teams.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#pull_request_bypassers BranchProtection#pull_request_bypassers}
public object RequireCodeOwnerReviews { get; set; }
- Type: object
Require an approved review in pull requests including files with a designated code owner.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#require_code_owner_reviews BranchProtection#require_code_owner_reviews}
public double RequiredApprovingReviewCount { get; set; }
- Type: double
Require 'x' number of approvals to satisfy branch protection requirements.
If this is specified it must be a number between 0-6.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#required_approving_review_count BranchProtection#required_approving_review_count}
public object RequireLastPushApproval { get; set; }
- Type: object
Require that The most recent push must be approved by someone other than the last pusher.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#require_last_push_approval BranchProtection#require_last_push_approval}
public object RestrictDismissals { get; set; }
- Type: object
Restrict pull request review dismissals.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#restrict_dismissals BranchProtection#restrict_dismissals}
using HashiCorp.Cdktf.Providers.Github;
new BranchProtectionRequiredStatusChecks {
string[] Contexts = null,
object Strict = null
};
Name | Type | Description |
---|---|---|
Contexts |
string[] |
The list of status checks to require in order to merge into this branch. |
Strict |
object |
Require branches to be up to date before merging. |
public string[] Contexts { get; set; }
- Type: string[]
The list of status checks to require in order to merge into this branch.
No status checks are required by default.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#contexts BranchProtection#contexts}
public object Strict { get; set; }
- Type: object
Require branches to be up to date before merging.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#strict BranchProtection#strict}
using HashiCorp.Cdktf.Providers.Github;
new BranchProtectionRestrictPushes {
object BlocksCreations = null,
string[] PushAllowances = null
};
Name | Type | Description |
---|---|---|
BlocksCreations |
object |
Restrict pushes that create matching branches. |
PushAllowances |
string[] |
The list of actor Names/IDs that may push to the branch. |
public object BlocksCreations { get; set; }
- Type: object
Restrict pushes that create matching branches.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#blocks_creations BranchProtection#blocks_creations}
public string[] PushAllowances { get; set; }
- Type: string[]
The list of actor Names/IDs that may push to the branch.
Actor names must either begin with a '/' for users or the organization name followed by a '/' for teams.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/branch_protection#push_allowances BranchProtection#push_allowances}
using HashiCorp.Cdktf.Providers.Github;
new BranchProtectionRequiredPullRequestReviewsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);
Name | Type | Description |
---|---|---|
TerraformResource |
HashiCorp.Cdktf.IInterpolatingParent |
The parent resource. |
TerraformAttribute |
string |
The attribute on the parent resource this class is referencing. |
WrapsSet |
bool |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: HashiCorp.Cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
- Type: bool
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
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. |
private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName)
Creating an iterator for this complex list.
The list will be converted into a map with the mapKeyAttributeName as the key.
- Type: string
private string ComputeFqn()
private object Resolve(IResolveContext Context)
Produce the Token's value at resolution time.
- Type: HashiCorp.Cdktf.IResolveContext
private string ToString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
private BranchProtectionRequiredPullRequestReviewsOutputReference Get(double Index)
- Type: double
the index of the item to return.
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 |
object |
No description. |
public string[] CreationStack { get; }
- 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.
public string Fqn { get; }
- Type: string
public object InternalValue { get; }
- Type: object
using HashiCorp.Cdktf.Providers.Github;
new BranchProtectionRequiredPullRequestReviewsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);
Name | Type | Description |
---|---|---|
TerraformResource |
HashiCorp.Cdktf.IInterpolatingParent |
The parent resource. |
TerraformAttribute |
string |
The attribute on the parent resource this class is referencing. |
ComplexObjectIndex |
double |
the index of this item in the list. |
ComplexObjectIsFromSet |
bool |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: HashiCorp.Cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
- Type: double
the index of this item in the list.
- Type: bool
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
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. |
ResetDismissalRestrictions |
No description. |
ResetDismissStaleReviews |
No description. |
ResetPullRequestBypassers |
No description. |
ResetRequireCodeOwnerReviews |
No description. |
ResetRequiredApprovingReviewCount |
No description. |
ResetRequireLastPushApproval |
No description. |
ResetRestrictDismissals |
No description. |
private string ComputeFqn()
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
- Type: string
private IResolvable GetBooleanAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
- Type: string
private string[] GetListAttribute(string TerraformAttribute)
- Type: string
private double GetNumberAttribute(string TerraformAttribute)
- Type: string
private double[] GetNumberListAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
- Type: string
private string GetStringAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
- Type: string
private IResolvable InterpolationForAttribute(string Property)
- Type: string
private object Resolve(IResolveContext Context)
Produce the Token's value at resolution time.
- Type: HashiCorp.Cdktf.IResolveContext
private string ToString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
private void ResetDismissalRestrictions()
private void ResetDismissStaleReviews()
private void ResetPullRequestBypassers()
private void ResetRequireCodeOwnerReviews()
private void ResetRequiredApprovingReviewCount()
private void ResetRequireLastPushApproval()
private void ResetRestrictDismissals()
Name | Type | Description |
---|---|---|
CreationStack |
string[] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
Fqn |
string |
No description. |
DismissalRestrictionsInput |
string[] |
No description. |
DismissStaleReviewsInput |
object |
No description. |
PullRequestBypassersInput |
string[] |
No description. |
RequireCodeOwnerReviewsInput |
object |
No description. |
RequiredApprovingReviewCountInput |
double |
No description. |
RequireLastPushApprovalInput |
object |
No description. |
RestrictDismissalsInput |
object |
No description. |
DismissalRestrictions |
string[] |
No description. |
DismissStaleReviews |
object |
No description. |
PullRequestBypassers |
string[] |
No description. |
RequireCodeOwnerReviews |
object |
No description. |
RequiredApprovingReviewCount |
double |
No description. |
RequireLastPushApproval |
object |
No description. |
RestrictDismissals |
object |
No description. |
InternalValue |
object |
No description. |
public string[] CreationStack { get; }
- 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.
public string Fqn { get; }
- Type: string
public string[] DismissalRestrictionsInput { get; }
- Type: string[]
public object DismissStaleReviewsInput { get; }
- Type: object
public string[] PullRequestBypassersInput { get; }
- Type: string[]
public object RequireCodeOwnerReviewsInput { get; }
- Type: object
public double RequiredApprovingReviewCountInput { get; }
- Type: double
public object RequireLastPushApprovalInput { get; }
- Type: object
public object RestrictDismissalsInput { get; }
- Type: object
public string[] DismissalRestrictions { get; }
- Type: string[]
public object DismissStaleReviews { get; }
- Type: object
public string[] PullRequestBypassers { get; }
- Type: string[]
public object RequireCodeOwnerReviews { get; }
- Type: object
public double RequiredApprovingReviewCount { get; }
- Type: double
public object RequireLastPushApproval { get; }
- Type: object
public object RestrictDismissals { get; }
- Type: object
public object InternalValue { get; }
- Type: object
using HashiCorp.Cdktf.Providers.Github;
new BranchProtectionRequiredStatusChecksList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);
Name | Type | Description |
---|---|---|
TerraformResource |
HashiCorp.Cdktf.IInterpolatingParent |
The parent resource. |
TerraformAttribute |
string |
The attribute on the parent resource this class is referencing. |
WrapsSet |
bool |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: HashiCorp.Cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
- Type: bool
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
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. |
private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName)
Creating an iterator for this complex list.
The list will be converted into a map with the mapKeyAttributeName as the key.
- Type: string
private string ComputeFqn()
private object Resolve(IResolveContext Context)
Produce the Token's value at resolution time.
- Type: HashiCorp.Cdktf.IResolveContext
private string ToString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
private BranchProtectionRequiredStatusChecksOutputReference Get(double Index)
- Type: double
the index of the item to return.
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 |
object |
No description. |
public string[] CreationStack { get; }
- 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.
public string Fqn { get; }
- Type: string
public object InternalValue { get; }
- Type: object
using HashiCorp.Cdktf.Providers.Github;
new BranchProtectionRequiredStatusChecksOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);
Name | Type | Description |
---|---|---|
TerraformResource |
HashiCorp.Cdktf.IInterpolatingParent |
The parent resource. |
TerraformAttribute |
string |
The attribute on the parent resource this class is referencing. |
ComplexObjectIndex |
double |
the index of this item in the list. |
ComplexObjectIsFromSet |
bool |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: HashiCorp.Cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
- Type: double
the index of this item in the list.
- Type: bool
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
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. |
ResetContexts |
No description. |
ResetStrict |
No description. |
private string ComputeFqn()
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
- Type: string
private IResolvable GetBooleanAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
- Type: string
private string[] GetListAttribute(string TerraformAttribute)
- Type: string
private double GetNumberAttribute(string TerraformAttribute)
- Type: string
private double[] GetNumberListAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
- Type: string
private string GetStringAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
- Type: string
private IResolvable InterpolationForAttribute(string Property)
- Type: string
private object Resolve(IResolveContext Context)
Produce the Token's value at resolution time.
- Type: HashiCorp.Cdktf.IResolveContext
private string ToString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
private void ResetContexts()
private void ResetStrict()
Name | Type | Description |
---|---|---|
CreationStack |
string[] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
Fqn |
string |
No description. |
ContextsInput |
string[] |
No description. |
StrictInput |
object |
No description. |
Contexts |
string[] |
No description. |
Strict |
object |
No description. |
InternalValue |
object |
No description. |
public string[] CreationStack { get; }
- 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.
public string Fqn { get; }
- Type: string
public string[] ContextsInput { get; }
- Type: string[]
public object StrictInput { get; }
- Type: object
public string[] Contexts { get; }
- Type: string[]
public object Strict { get; }
- Type: object
public object InternalValue { get; }
- Type: object
using HashiCorp.Cdktf.Providers.Github;
new BranchProtectionRestrictPushesList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);
Name | Type | Description |
---|---|---|
TerraformResource |
HashiCorp.Cdktf.IInterpolatingParent |
The parent resource. |
TerraformAttribute |
string |
The attribute on the parent resource this class is referencing. |
WrapsSet |
bool |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: HashiCorp.Cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
- Type: bool
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
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. |
private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName)
Creating an iterator for this complex list.
The list will be converted into a map with the mapKeyAttributeName as the key.
- Type: string
private string ComputeFqn()
private object Resolve(IResolveContext Context)
Produce the Token's value at resolution time.
- Type: HashiCorp.Cdktf.IResolveContext
private string ToString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
private BranchProtectionRestrictPushesOutputReference Get(double Index)
- Type: double
the index of the item to return.
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 |
object |
No description. |
public string[] CreationStack { get; }
- 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.
public string Fqn { get; }
- Type: string
public object InternalValue { get; }
- Type: object
using HashiCorp.Cdktf.Providers.Github;
new BranchProtectionRestrictPushesOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);
Name | Type | Description |
---|---|---|
TerraformResource |
HashiCorp.Cdktf.IInterpolatingParent |
The parent resource. |
TerraformAttribute |
string |
The attribute on the parent resource this class is referencing. |
ComplexObjectIndex |
double |
the index of this item in the list. |
ComplexObjectIsFromSet |
bool |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: HashiCorp.Cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
- Type: double
the index of this item in the list.
- Type: bool
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
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. |
ResetBlocksCreations |
No description. |
ResetPushAllowances |
No description. |
private string ComputeFqn()
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
- Type: string
private IResolvable GetBooleanAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
- Type: string
private string[] GetListAttribute(string TerraformAttribute)
- Type: string
private double GetNumberAttribute(string TerraformAttribute)
- Type: string
private double[] GetNumberListAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
- Type: string
private string GetStringAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
- Type: string
private IResolvable InterpolationForAttribute(string Property)
- Type: string
private object Resolve(IResolveContext Context)
Produce the Token's value at resolution time.
- Type: HashiCorp.Cdktf.IResolveContext
private string ToString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
private void ResetBlocksCreations()
private void ResetPushAllowances()
Name | Type | Description |
---|---|---|
CreationStack |
string[] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
Fqn |
string |
No description. |
BlocksCreationsInput |
object |
No description. |
PushAllowancesInput |
string[] |
No description. |
BlocksCreations |
object |
No description. |
PushAllowances |
string[] |
No description. |
InternalValue |
object |
No description. |
public string[] CreationStack { get; }
- 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.
public string Fqn { get; }
- Type: string
public object BlocksCreationsInput { get; }
- Type: object
public string[] PushAllowancesInput { get; }
- Type: string[]
public object BlocksCreations { get; }
- Type: object
public string[] PushAllowances { get; }
- Type: string[]
public object InternalValue { get; }
- Type: object