Documentation
¶
Index ¶
- func BranchProtection_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func BranchProtection_IsConstruct(x interface{}) *bool
- func BranchProtection_IsTerraformElement(x interface{}) *bool
- func BranchProtection_IsTerraformResource(x interface{}) *bool
- func BranchProtection_TfResourceType() *string
- func NewBranchProtectionRequiredPullRequestReviewsList_Override(b BranchProtectionRequiredPullRequestReviewsList, ...)
- func NewBranchProtectionRequiredPullRequestReviewsOutputReference_Override(b BranchProtectionRequiredPullRequestReviewsOutputReference, ...)
- func NewBranchProtectionRequiredStatusChecksList_Override(b BranchProtectionRequiredStatusChecksList, ...)
- func NewBranchProtectionRequiredStatusChecksOutputReference_Override(b BranchProtectionRequiredStatusChecksOutputReference, ...)
- func NewBranchProtection_Override(b BranchProtection, scope constructs.Construct, id *string, ...)
- type BranchProtection
- type BranchProtectionConfig
- type BranchProtectionRequiredPullRequestReviews
- type BranchProtectionRequiredPullRequestReviewsList
- type BranchProtectionRequiredPullRequestReviewsOutputReference
- type BranchProtectionRequiredStatusChecks
- type BranchProtectionRequiredStatusChecksList
- type BranchProtectionRequiredStatusChecksOutputReference
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BranchProtection_GenerateConfigForImport ¶
func BranchProtection_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a BranchProtection resource upon running "cdktf plan <stack-name>".
func BranchProtection_IsConstruct ¶
func BranchProtection_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func BranchProtection_IsTerraformElement ¶
func BranchProtection_IsTerraformElement(x interface{}) *bool
Experimental.
func BranchProtection_IsTerraformResource ¶
func BranchProtection_IsTerraformResource(x interface{}) *bool
Experimental.
func BranchProtection_TfResourceType ¶
func BranchProtection_TfResourceType() *string
func NewBranchProtectionRequiredPullRequestReviewsList_Override ¶
func NewBranchProtectionRequiredPullRequestReviewsList_Override(b BranchProtectionRequiredPullRequestReviewsList, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool)
func NewBranchProtectionRequiredPullRequestReviewsOutputReference_Override ¶
func NewBranchProtectionRequiredPullRequestReviewsOutputReference_Override(b BranchProtectionRequiredPullRequestReviewsOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool)
func NewBranchProtectionRequiredStatusChecksList_Override ¶
func NewBranchProtectionRequiredStatusChecksList_Override(b BranchProtectionRequiredStatusChecksList, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool)
func NewBranchProtectionRequiredStatusChecksOutputReference_Override ¶
func NewBranchProtectionRequiredStatusChecksOutputReference_Override(b BranchProtectionRequiredStatusChecksOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool)
func NewBranchProtection_Override ¶
func NewBranchProtection_Override(b BranchProtection, scope constructs.Construct, id *string, config *BranchProtectionConfig)
Create a new {@link https://registry.terraform.io/providers/integrations/github/5.43.0/docs/resources/branch_protection github_branch_protection} Resource.
Types ¶
type BranchProtection ¶
type BranchProtection interface {
cdktf.TerraformResource
AllowsDeletions() interface{}
SetAllowsDeletions(val interface{})
AllowsDeletionsInput() interface{}
AllowsForcePushes() interface{}
SetAllowsForcePushes(val interface{})
AllowsForcePushesInput() interface{}
BlocksCreations() interface{}
SetBlocksCreations(val interface{})
BlocksCreationsInput() interface{}
// Experimental.
CdktfStack() cdktf.TerraformStack
// Experimental.
Connection() interface{}
// Experimental.
SetConnection(val interface{})
// Experimental.
ConstructNodeMetadata() *map[string]interface{}
// Experimental.
Count() interface{}
// Experimental.
SetCount(val interface{})
// Experimental.
DependsOn() *[]*string
// Experimental.
SetDependsOn(val *[]*string)
EnforceAdmins() interface{}
SetEnforceAdmins(val interface{})
EnforceAdminsInput() interface{}
ForcePushBypassers() *[]*string
SetForcePushBypassers(val *[]*string)
ForcePushBypassersInput() *[]*string
// Experimental.
ForEach() cdktf.ITerraformIterator
// Experimental.
SetForEach(val cdktf.ITerraformIterator)
// Experimental.
Fqn() *string
// Experimental.
FriendlyUniqueId() *string
Id() *string
SetId(val *string)
IdInput() *string
// Experimental.
Lifecycle() *cdktf.TerraformResourceLifecycle
// Experimental.
SetLifecycle(val *cdktf.TerraformResourceLifecycle)
LockBranch() interface{}
SetLockBranch(val interface{})
LockBranchInput() interface{}
// The tree node.
Node() constructs.Node
Pattern() *string
SetPattern(val *string)
PatternInput() *string
// Experimental.
Provider() cdktf.TerraformProvider
// Experimental.
SetProvider(val cdktf.TerraformProvider)
// Experimental.
Provisioners() *[]interface{}
// Experimental.
SetProvisioners(val *[]interface{})
PushRestrictions() *[]*string
SetPushRestrictions(val *[]*string)
PushRestrictionsInput() *[]*string
// Experimental.
RawOverrides() interface{}
RepositoryId() *string
SetRepositoryId(val *string)
RepositoryIdInput() *string
RequireConversationResolution() interface{}
SetRequireConversationResolution(val interface{})
RequireConversationResolutionInput() interface{}
RequiredLinearHistory() interface{}
SetRequiredLinearHistory(val interface{})
RequiredLinearHistoryInput() interface{}
RequiredPullRequestReviews() BranchProtectionRequiredPullRequestReviewsList
RequiredPullRequestReviewsInput() interface{}
RequiredStatusChecks() BranchProtectionRequiredStatusChecksList
RequiredStatusChecksInput() interface{}
RequireSignedCommits() interface{}
SetRequireSignedCommits(val interface{})
RequireSignedCommitsInput() interface{}
// Experimental.
TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
// Experimental.
TerraformMetaArguments() *map[string]interface{}
// Experimental.
TerraformResourceType() *string
// Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
// Experimental.
AddMoveTarget(moveTarget *string)
// Experimental.
AddOverride(path *string, value interface{})
// Experimental.
GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
// Experimental.
GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
// Experimental.
GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
// Experimental.
GetListAttribute(terraformAttribute *string) *[]*string
// Experimental.
GetNumberAttribute(terraformAttribute *string) *float64
// Experimental.
GetNumberListAttribute(terraformAttribute *string) *[]*float64
// Experimental.
GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
// Experimental.
GetStringAttribute(terraformAttribute *string) *string
// Experimental.
GetStringMapAttribute(terraformAttribute *string) *map[string]*string
// Experimental.
HasResourceMove() interface{}
// Experimental.
ImportFrom(id *string, provider cdktf.TerraformProvider)
// Experimental.
InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
// 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.
// Experimental.
MoveFromId(id *string)
// Moves this resource to the target resource given by moveTarget.
// Experimental.
MoveTo(moveTarget *string, index interface{})
// Moves this resource to the resource corresponding to "id".
// Experimental.
MoveToId(id *string)
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
PutRequiredPullRequestReviews(value interface{})
PutRequiredStatusChecks(value interface{})
ResetAllowsDeletions()
ResetAllowsForcePushes()
ResetBlocksCreations()
ResetEnforceAdmins()
ResetForcePushBypassers()
ResetId()
ResetLockBranch()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
ResetPushRestrictions()
ResetRequireConversationResolution()
ResetRequiredLinearHistory()
ResetRequiredPullRequestReviews()
ResetRequiredStatusChecks()
ResetRequireSignedCommits()
SynthesizeAttributes() *map[string]interface{}
// Experimental.
ToMetadata() interface{}
// Returns a string representation of this construct.
ToString() *string
// Adds this resource to the terraform JSON output.
// Experimental.
ToTerraform() interface{}
}
Represents a {@link https://registry.terraform.io/providers/integrations/github/5.43.0/docs/resources/branch_protection github_branch_protection}.
func NewBranchProtection ¶
func NewBranchProtection(scope constructs.Construct, id *string, config *BranchProtectionConfig) BranchProtection
Create a new {@link https://registry.terraform.io/providers/integrations/github/5.43.0/docs/resources/branch_protection github_branch_protection} Resource.
type BranchProtectionConfig ¶
type BranchProtectionConfig struct {
// Experimental.
Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
// Experimental.
Count interface{} `field:"optional" json:"count" yaml:"count"`
// Experimental.
DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
// Experimental.
ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
// Experimental.
Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
// Experimental.
Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
// Experimental.
Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
// Identifies the protection rule pattern.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.43.0/docs/resources/branch_protection#pattern BranchProtection#pattern}
Pattern *string `field:"required" json:"pattern" yaml:"pattern"`
// 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/5.43.0/docs/resources/branch_protection#repository_id BranchProtection#repository_id}
RepositoryId *string `field:"required" json:"repositoryId" yaml:"repositoryId"`
// Setting this to 'true' to allow the branch to be deleted.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.43.0/docs/resources/branch_protection#allows_deletions BranchProtection#allows_deletions}
AllowsDeletions interface{} `field:"optional" json:"allowsDeletions" yaml:"allowsDeletions"`
// Setting this to 'true' to allow force pushes on the branch.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.43.0/docs/resources/branch_protection#allows_force_pushes BranchProtection#allows_force_pushes}
AllowsForcePushes interface{} `field:"optional" json:"allowsForcePushes" yaml:"allowsForcePushes"`
// Setting this to 'true' to block creating the branch.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.43.0/docs/resources/branch_protection#blocks_creations BranchProtection#blocks_creations}
BlocksCreations interface{} `field:"optional" json:"blocksCreations" yaml:"blocksCreations"`
// Setting this to 'true' enforces status checks for repository administrators.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.43.0/docs/resources/branch_protection#enforce_admins BranchProtection#enforce_admins}
EnforceAdmins interface{} `field:"optional" json:"enforceAdmins" yaml:"enforceAdmins"`
// 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/5.43.0/docs/resources/branch_protection#force_push_bypassers BranchProtection#force_push_bypassers}
ForcePushBypassers *[]*string `field:"optional" json:"forcePushBypassers" yaml:"forcePushBypassers"`
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.43.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.
Id *string `field:"optional" json:"id" yaml:"id"`
// 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/5.43.0/docs/resources/branch_protection#lock_branch BranchProtection#lock_branch}
LockBranch interface{} `field:"optional" json:"lockBranch" yaml:"lockBranch"`
// 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/5.43.0/docs/resources/branch_protection#push_restrictions BranchProtection#push_restrictions}
PushRestrictions *[]*string `field:"optional" json:"pushRestrictions" yaml:"pushRestrictions"`
// 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/5.43.0/docs/resources/branch_protection#require_conversation_resolution BranchProtection#require_conversation_resolution}
RequireConversationResolution interface{} `field:"optional" json:"requireConversationResolution" yaml:"requireConversationResolution"`
// 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/5.43.0/docs/resources/branch_protection#required_linear_history BranchProtection#required_linear_history}
RequiredLinearHistory interface{} `field:"optional" json:"requiredLinearHistory" yaml:"requiredLinearHistory"`
// required_pull_request_reviews block.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.43.0/docs/resources/branch_protection#required_pull_request_reviews BranchProtection#required_pull_request_reviews}
RequiredPullRequestReviews interface{} `field:"optional" json:"requiredPullRequestReviews" yaml:"requiredPullRequestReviews"`
// required_status_checks block.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.43.0/docs/resources/branch_protection#required_status_checks BranchProtection#required_status_checks}
RequiredStatusChecks interface{} `field:"optional" json:"requiredStatusChecks" yaml:"requiredStatusChecks"`
// Setting this to 'true' requires all commits to be signed with GPG.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.43.0/docs/resources/branch_protection#require_signed_commits BranchProtection#require_signed_commits}
RequireSignedCommits interface{} `field:"optional" json:"requireSignedCommits" yaml:"requireSignedCommits"`
}
type BranchProtectionRequiredPullRequestReviews ¶
type BranchProtectionRequiredPullRequestReviews struct {
// 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/5.43.0/docs/resources/branch_protection#dismissal_restrictions BranchProtection#dismissal_restrictions}
DismissalRestrictions *[]*string `field:"optional" json:"dismissalRestrictions" yaml:"dismissalRestrictions"`
// Dismiss approved reviews automatically when a new commit is pushed.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.43.0/docs/resources/branch_protection#dismiss_stale_reviews BranchProtection#dismiss_stale_reviews}
DismissStaleReviews interface{} `field:"optional" json:"dismissStaleReviews" yaml:"dismissStaleReviews"`
// 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/5.43.0/docs/resources/branch_protection#pull_request_bypassers BranchProtection#pull_request_bypassers}
PullRequestBypassers *[]*string `field:"optional" json:"pullRequestBypassers" yaml:"pullRequestBypassers"`
// 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/5.43.0/docs/resources/branch_protection#require_code_owner_reviews BranchProtection#require_code_owner_reviews}
RequireCodeOwnerReviews interface{} `field:"optional" json:"requireCodeOwnerReviews" yaml:"requireCodeOwnerReviews"`
// 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/5.43.0/docs/resources/branch_protection#required_approving_review_count BranchProtection#required_approving_review_count}
RequiredApprovingReviewCount *float64 `field:"optional" json:"requiredApprovingReviewCount" yaml:"requiredApprovingReviewCount"`
// 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/5.43.0/docs/resources/branch_protection#require_last_push_approval BranchProtection#require_last_push_approval}
RequireLastPushApproval interface{} `field:"optional" json:"requireLastPushApproval" yaml:"requireLastPushApproval"`
// Restrict pull request review dismissals.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.43.0/docs/resources/branch_protection#restrict_dismissals BranchProtection#restrict_dismissals}
RestrictDismissals interface{} `field:"optional" json:"restrictDismissals" yaml:"restrictDismissals"`
}
type BranchProtectionRequiredPullRequestReviewsList ¶
type BranchProtectionRequiredPullRequestReviewsList interface {
cdktf.ComplexList
// 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.
// Experimental.
CreationStack() *[]*string
// Experimental.
Fqn() *string
InternalValue() interface{}
SetInternalValue(val interface{})
// The attribute on the parent resource this class is referencing.
TerraformAttribute() *string
SetTerraformAttribute(val *string)
// The parent resource.
TerraformResource() cdktf.IInterpolatingParent
SetTerraformResource(val cdktf.IInterpolatingParent)
// whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
WrapsSet() *bool
SetWrapsSet(val *bool)
// Experimental.
ComputeFqn() *string
Get(index *float64) BranchProtectionRequiredPullRequestReviewsOutputReference
// Produce the Token's value at resolution time.
// Experimental.
Resolve(_context cdktf.IResolveContext) interface{}
// Return a string representation of this resolvable object.
//
// Returns a reversible string representation.
// Experimental.
ToString() *string
}
func NewBranchProtectionRequiredPullRequestReviewsList ¶
func NewBranchProtectionRequiredPullRequestReviewsList(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) BranchProtectionRequiredPullRequestReviewsList
type BranchProtectionRequiredPullRequestReviewsOutputReference ¶
type BranchProtectionRequiredPullRequestReviewsOutputReference interface {
cdktf.ComplexObject
// the index of the complex object in a list.
// Experimental.
ComplexObjectIndex() interface{}
// Experimental.
SetComplexObjectIndex(val interface{})
// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
// Experimental.
ComplexObjectIsFromSet() *bool
// Experimental.
SetComplexObjectIsFromSet(val *bool)
// 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.
// Experimental.
CreationStack() *[]*string
DismissalRestrictions() *[]*string
SetDismissalRestrictions(val *[]*string)
DismissalRestrictionsInput() *[]*string
DismissStaleReviews() interface{}
SetDismissStaleReviews(val interface{})
DismissStaleReviewsInput() interface{}
// Experimental.
Fqn() *string
InternalValue() interface{}
SetInternalValue(val interface{})
PullRequestBypassers() *[]*string
SetPullRequestBypassers(val *[]*string)
PullRequestBypassersInput() *[]*string
RequireCodeOwnerReviews() interface{}
SetRequireCodeOwnerReviews(val interface{})
RequireCodeOwnerReviewsInput() interface{}
RequiredApprovingReviewCount() *float64
SetRequiredApprovingReviewCount(val *float64)
RequiredApprovingReviewCountInput() *float64
RequireLastPushApproval() interface{}
SetRequireLastPushApproval(val interface{})
RequireLastPushApprovalInput() interface{}
RestrictDismissals() interface{}
SetRestrictDismissals(val interface{})
RestrictDismissalsInput() interface{}
// Experimental.
TerraformAttribute() *string
// Experimental.
SetTerraformAttribute(val *string)
// Experimental.
TerraformResource() cdktf.IInterpolatingParent
// Experimental.
SetTerraformResource(val cdktf.IInterpolatingParent)
// Experimental.
ComputeFqn() *string
// Experimental.
GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
// Experimental.
GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
// Experimental.
GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
// Experimental.
GetListAttribute(terraformAttribute *string) *[]*string
// Experimental.
GetNumberAttribute(terraformAttribute *string) *float64
// Experimental.
GetNumberListAttribute(terraformAttribute *string) *[]*float64
// Experimental.
GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
// Experimental.
GetStringAttribute(terraformAttribute *string) *string
// Experimental.
GetStringMapAttribute(terraformAttribute *string) *map[string]*string
// Experimental.
InterpolationAsList() cdktf.IResolvable
// Experimental.
InterpolationForAttribute(property *string) cdktf.IResolvable
ResetDismissalRestrictions()
ResetDismissStaleReviews()
ResetPullRequestBypassers()
ResetRequireCodeOwnerReviews()
ResetRequiredApprovingReviewCount()
ResetRequireLastPushApproval()
ResetRestrictDismissals()
// Produce the Token's value at resolution time.
// Experimental.
Resolve(_context cdktf.IResolveContext) interface{}
// Return a string representation of this resolvable object.
//
// Returns a reversible string representation.
// Experimental.
ToString() *string
}
func NewBranchProtectionRequiredPullRequestReviewsOutputReference ¶
func NewBranchProtectionRequiredPullRequestReviewsOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool) BranchProtectionRequiredPullRequestReviewsOutputReference
type BranchProtectionRequiredStatusChecks ¶
type BranchProtectionRequiredStatusChecks struct {
// 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/5.43.0/docs/resources/branch_protection#contexts BranchProtection#contexts}
Contexts *[]*string `field:"optional" json:"contexts" yaml:"contexts"`
// Require branches to be up to date before merging.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.43.0/docs/resources/branch_protection#strict BranchProtection#strict}
Strict interface{} `field:"optional" json:"strict" yaml:"strict"`
}
type BranchProtectionRequiredStatusChecksList ¶
type BranchProtectionRequiredStatusChecksList interface {
cdktf.ComplexList
// 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.
// Experimental.
CreationStack() *[]*string
// Experimental.
Fqn() *string
InternalValue() interface{}
SetInternalValue(val interface{})
// The attribute on the parent resource this class is referencing.
TerraformAttribute() *string
SetTerraformAttribute(val *string)
// The parent resource.
TerraformResource() cdktf.IInterpolatingParent
SetTerraformResource(val cdktf.IInterpolatingParent)
// whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
WrapsSet() *bool
SetWrapsSet(val *bool)
// Experimental.
ComputeFqn() *string
Get(index *float64) BranchProtectionRequiredStatusChecksOutputReference
// Produce the Token's value at resolution time.
// Experimental.
Resolve(_context cdktf.IResolveContext) interface{}
// Return a string representation of this resolvable object.
//
// Returns a reversible string representation.
// Experimental.
ToString() *string
}
func NewBranchProtectionRequiredStatusChecksList ¶
func NewBranchProtectionRequiredStatusChecksList(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) BranchProtectionRequiredStatusChecksList
type BranchProtectionRequiredStatusChecksOutputReference ¶
type BranchProtectionRequiredStatusChecksOutputReference interface {
cdktf.ComplexObject
// the index of the complex object in a list.
// Experimental.
ComplexObjectIndex() interface{}
// Experimental.
SetComplexObjectIndex(val interface{})
// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
// Experimental.
ComplexObjectIsFromSet() *bool
// Experimental.
SetComplexObjectIsFromSet(val *bool)
Contexts() *[]*string
SetContexts(val *[]*string)
ContextsInput() *[]*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.
// Experimental.
CreationStack() *[]*string
// Experimental.
Fqn() *string
InternalValue() interface{}
SetInternalValue(val interface{})
Strict() interface{}
SetStrict(val interface{})
StrictInput() interface{}
// Experimental.
TerraformAttribute() *string
// Experimental.
SetTerraformAttribute(val *string)
// Experimental.
TerraformResource() cdktf.IInterpolatingParent
// Experimental.
SetTerraformResource(val cdktf.IInterpolatingParent)
// Experimental.
ComputeFqn() *string
// Experimental.
GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
// Experimental.
GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
// Experimental.
GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
// Experimental.
GetListAttribute(terraformAttribute *string) *[]*string
// Experimental.
GetNumberAttribute(terraformAttribute *string) *float64
// Experimental.
GetNumberListAttribute(terraformAttribute *string) *[]*float64
// Experimental.
GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
// Experimental.
GetStringAttribute(terraformAttribute *string) *string
// Experimental.
GetStringMapAttribute(terraformAttribute *string) *map[string]*string
// Experimental.
InterpolationAsList() cdktf.IResolvable
// Experimental.
InterpolationForAttribute(property *string) cdktf.IResolvable
ResetContexts()
ResetStrict()
// Produce the Token's value at resolution time.
// Experimental.
Resolve(_context cdktf.IResolveContext) interface{}
// Return a string representation of this resolvable object.
//
// Returns a reversible string representation.
// Experimental.
ToString() *string
}
func NewBranchProtectionRequiredStatusChecksOutputReference ¶
func NewBranchProtectionRequiredStatusChecksOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool) BranchProtectionRequiredStatusChecksOutputReference
Source Files
¶
- BranchProtection.go
- BranchProtectionConfig.go
- BranchProtectionRequiredPullRequestReviews.go
- BranchProtectionRequiredPullRequestReviewsList.go
- BranchProtectionRequiredPullRequestReviewsList__checks.go
- BranchProtectionRequiredPullRequestReviewsOutputReference.go
- BranchProtectionRequiredPullRequestReviewsOutputReference__checks.go
- BranchProtectionRequiredStatusChecks.go
- BranchProtectionRequiredStatusChecksList.go
- BranchProtectionRequiredStatusChecksList__checks.go
- BranchProtectionRequiredStatusChecksOutputReference.go
- BranchProtectionRequiredStatusChecksOutputReference__checks.go
- BranchProtection__checks.go
- main.go