Documentation
¶
Index ¶
- func BranchProtectionV3_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func BranchProtectionV3_IsConstruct(x interface{}) *bool
- func BranchProtectionV3_IsTerraformElement(x interface{}) *bool
- func BranchProtectionV3_IsTerraformResource(x interface{}) *bool
- func BranchProtectionV3_TfResourceType() *string
- func NewBranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference_Override(...)
- func NewBranchProtectionV3RequiredPullRequestReviewsOutputReference_Override(b BranchProtectionV3RequiredPullRequestReviewsOutputReference, ...)
- func NewBranchProtectionV3RequiredStatusChecksOutputReference_Override(b BranchProtectionV3RequiredStatusChecksOutputReference, ...)
- func NewBranchProtectionV3RestrictionsOutputReference_Override(b BranchProtectionV3RestrictionsOutputReference, ...)
- func NewBranchProtectionV3_Override(b BranchProtectionV3, scope constructs.Construct, id *string, ...)
- type BranchProtectionV3
- type BranchProtectionV3Config
- type BranchProtectionV3RequiredPullRequestReviews
- type BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances
- type BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference
- type BranchProtectionV3RequiredPullRequestReviewsOutputReference
- type BranchProtectionV3RequiredStatusChecks
- type BranchProtectionV3RequiredStatusChecksOutputReference
- type BranchProtectionV3Restrictions
- type BranchProtectionV3RestrictionsOutputReference
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BranchProtectionV3_GenerateConfigForImport ¶
func BranchProtectionV3_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a BranchProtectionV3 resource upon running "cdktf plan <stack-name>".
func BranchProtectionV3_IsConstruct ¶
func BranchProtectionV3_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 BranchProtectionV3_IsTerraformElement ¶
func BranchProtectionV3_IsTerraformElement(x interface{}) *bool
Experimental.
func BranchProtectionV3_IsTerraformResource ¶
func BranchProtectionV3_IsTerraformResource(x interface{}) *bool
Experimental.
func BranchProtectionV3_TfResourceType ¶
func BranchProtectionV3_TfResourceType() *string
func NewBranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference_Override ¶
func NewBranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference_Override(b BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)
func NewBranchProtectionV3RequiredPullRequestReviewsOutputReference_Override ¶
func NewBranchProtectionV3RequiredPullRequestReviewsOutputReference_Override(b BranchProtectionV3RequiredPullRequestReviewsOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)
func NewBranchProtectionV3RequiredStatusChecksOutputReference_Override ¶
func NewBranchProtectionV3RequiredStatusChecksOutputReference_Override(b BranchProtectionV3RequiredStatusChecksOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)
func NewBranchProtectionV3RestrictionsOutputReference_Override ¶
func NewBranchProtectionV3RestrictionsOutputReference_Override(b BranchProtectionV3RestrictionsOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)
func NewBranchProtectionV3_Override ¶
func NewBranchProtectionV3_Override(b BranchProtectionV3, scope constructs.Construct, id *string, config *BranchProtectionV3Config)
Create a new {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3 github_branch_protection_v3} Resource.
Types ¶
type BranchProtectionV3 ¶
type BranchProtectionV3 interface {
cdktf.TerraformResource
Branch() *string
SetBranch(val *string)
BranchInput() *string
// 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{}
Etag() *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)
// The tree node.
Node() constructs.Node
// Experimental.
Provider() cdktf.TerraformProvider
// Experimental.
SetProvider(val cdktf.TerraformProvider)
// Experimental.
Provisioners() *[]interface{}
// Experimental.
SetProvisioners(val *[]interface{})
// Experimental.
RawOverrides() interface{}
Repository() *string
SetRepository(val *string)
RepositoryInput() *string
RequireConversationResolution() interface{}
SetRequireConversationResolution(val interface{})
RequireConversationResolutionInput() interface{}
RequiredPullRequestReviews() BranchProtectionV3RequiredPullRequestReviewsOutputReference
RequiredPullRequestReviewsInput() *BranchProtectionV3RequiredPullRequestReviews
RequiredStatusChecks() BranchProtectionV3RequiredStatusChecksOutputReference
RequiredStatusChecksInput() *BranchProtectionV3RequiredStatusChecks
RequireSignedCommits() interface{}
SetRequireSignedCommits(val interface{})
RequireSignedCommitsInput() interface{}
Restrictions() BranchProtectionV3RestrictionsOutputReference
RestrictionsInput() *BranchProtectionV3Restrictions
// 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 *BranchProtectionV3RequiredPullRequestReviews)
PutRequiredStatusChecks(value *BranchProtectionV3RequiredStatusChecks)
PutRestrictions(value *BranchProtectionV3Restrictions)
ResetEnforceAdmins()
ResetId()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
ResetRequireConversationResolution()
ResetRequiredPullRequestReviews()
ResetRequiredStatusChecks()
ResetRequireSignedCommits()
ResetRestrictions()
SynthesizeAttributes() *map[string]interface{}
SynthesizeHclAttributes() *map[string]interface{}
// Experimental.
ToHclTerraform() 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/6.3.1/docs/resources/branch_protection_v3 github_branch_protection_v3}.
func NewBranchProtectionV3 ¶
func NewBranchProtectionV3(scope constructs.Construct, id *string, config *BranchProtectionV3Config) BranchProtectionV3
Create a new {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3 github_branch_protection_v3} Resource.
type BranchProtectionV3Config ¶
type BranchProtectionV3Config 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"`
// The Git branch to protect.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3#branch BranchProtectionV3#branch}
Branch *string `field:"required" json:"branch" yaml:"branch"`
// The GitHub repository name.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3#repository BranchProtectionV3#repository}
Repository *string `field:"required" json:"repository" yaml:"repository"`
// Setting this to 'true' enforces status checks for repository administrators.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3#enforce_admins BranchProtectionV3#enforce_admins}
EnforceAdmins interface{} `field:"optional" json:"enforceAdmins" yaml:"enforceAdmins"`
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3#id BranchProtectionV3#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' 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.3.1/docs/resources/branch_protection_v3#require_conversation_resolution BranchProtectionV3#require_conversation_resolution}
RequireConversationResolution interface{} `field:"optional" json:"requireConversationResolution" yaml:"requireConversationResolution"`
// required_pull_request_reviews block.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3#required_pull_request_reviews BranchProtectionV3#required_pull_request_reviews}
RequiredPullRequestReviews *BranchProtectionV3RequiredPullRequestReviews `field:"optional" json:"requiredPullRequestReviews" yaml:"requiredPullRequestReviews"`
// required_status_checks block.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3#required_status_checks BranchProtectionV3#required_status_checks}
RequiredStatusChecks *BranchProtectionV3RequiredStatusChecks `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/6.3.1/docs/resources/branch_protection_v3#require_signed_commits BranchProtectionV3#require_signed_commits}
RequireSignedCommits interface{} `field:"optional" json:"requireSignedCommits" yaml:"requireSignedCommits"`
// restrictions block.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3#restrictions BranchProtectionV3#restrictions}
Restrictions *BranchProtectionV3Restrictions `field:"optional" json:"restrictions" yaml:"restrictions"`
}
type BranchProtectionV3RequiredPullRequestReviews ¶
type BranchProtectionV3RequiredPullRequestReviews struct {
// bypass_pull_request_allowances block.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3#bypass_pull_request_allowances BranchProtectionV3#bypass_pull_request_allowances}
BypassPullRequestAllowances *BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances `field:"optional" json:"bypassPullRequestAllowances" yaml:"bypassPullRequestAllowances"`
// The list of apps slugs with dismissal access.
//
// Always use slug of the app, not its name. Each app already has to have access to the repository.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3#dismissal_apps BranchProtectionV3#dismissal_apps}
DismissalApps *[]*string `field:"optional" json:"dismissalApps" yaml:"dismissalApps"`
// The list of team slugs with dismissal access.
//
// Always use slug of the team, not its name. Each team already has to have access to the repository.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3#dismissal_teams BranchProtectionV3#dismissal_teams}
DismissalTeams *[]*string `field:"optional" json:"dismissalTeams" yaml:"dismissalTeams"`
// The list of user logins with dismissal access.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3#dismissal_users BranchProtectionV3#dismissal_users}
DismissalUsers *[]*string `field:"optional" json:"dismissalUsers" yaml:"dismissalUsers"`
// Dismiss approved reviews automatically when a new commit is pushed.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3#dismiss_stale_reviews BranchProtectionV3#dismiss_stale_reviews}
DismissStaleReviews interface{} `field:"optional" json:"dismissStaleReviews" yaml:"dismissStaleReviews"`
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3#include_admins BranchProtectionV3#include_admins}.
IncludeAdmins interface{} `field:"optional" json:"includeAdmins" yaml:"includeAdmins"`
// 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.3.1/docs/resources/branch_protection_v3#require_code_owner_reviews BranchProtectionV3#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/6.3.1/docs/resources/branch_protection_v3#required_approving_review_count BranchProtectionV3#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/6.3.1/docs/resources/branch_protection_v3#require_last_push_approval BranchProtectionV3#require_last_push_approval}
RequireLastPushApproval interface{} `field:"optional" json:"requireLastPushApproval" yaml:"requireLastPushApproval"`
}
type BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances ¶
type BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances struct {
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3#apps BranchProtectionV3#apps}.
Apps *[]*string `field:"optional" json:"apps" yaml:"apps"`
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3#teams BranchProtectionV3#teams}.
Teams *[]*string `field:"optional" json:"teams" yaml:"teams"`
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3#users BranchProtectionV3#users}.
Users *[]*string `field:"optional" json:"users" yaml:"users"`
}
type BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference ¶
type BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference interface {
cdktf.ComplexObject
Apps() *[]*string
SetApps(val *[]*string)
AppsInput() *[]*string
// 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
// Experimental.
Fqn() *string
InternalValue() *BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances
SetInternalValue(val *BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances)
Teams() *[]*string
SetTeams(val *[]*string)
TeamsInput() *[]*string
// Experimental.
TerraformAttribute() *string
// Experimental.
SetTerraformAttribute(val *string)
// Experimental.
TerraformResource() cdktf.IInterpolatingParent
// Experimental.
SetTerraformResource(val cdktf.IInterpolatingParent)
Users() *[]*string
SetUsers(val *[]*string)
UsersInput() *[]*string
// 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
ResetApps()
ResetTeams()
ResetUsers()
// 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 NewBranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference ¶
func NewBranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference
type BranchProtectionV3RequiredPullRequestReviewsOutputReference ¶
type BranchProtectionV3RequiredPullRequestReviewsOutputReference interface {
cdktf.ComplexObject
BypassPullRequestAllowances() BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference
BypassPullRequestAllowancesInput() *BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances
// 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
DismissalApps() *[]*string
SetDismissalApps(val *[]*string)
DismissalAppsInput() *[]*string
DismissalTeams() *[]*string
SetDismissalTeams(val *[]*string)
DismissalTeamsInput() *[]*string
DismissalUsers() *[]*string
SetDismissalUsers(val *[]*string)
DismissalUsersInput() *[]*string
DismissStaleReviews() interface{}
SetDismissStaleReviews(val interface{})
DismissStaleReviewsInput() interface{}
// Experimental.
Fqn() *string
IncludeAdmins() interface{}
SetIncludeAdmins(val interface{})
IncludeAdminsInput() interface{}
InternalValue() *BranchProtectionV3RequiredPullRequestReviews
SetInternalValue(val *BranchProtectionV3RequiredPullRequestReviews)
RequireCodeOwnerReviews() interface{}
SetRequireCodeOwnerReviews(val interface{})
RequireCodeOwnerReviewsInput() interface{}
RequiredApprovingReviewCount() *float64
SetRequiredApprovingReviewCount(val *float64)
RequiredApprovingReviewCountInput() *float64
RequireLastPushApproval() interface{}
SetRequireLastPushApproval(val interface{})
RequireLastPushApprovalInput() 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
PutBypassPullRequestAllowances(value *BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances)
ResetBypassPullRequestAllowances()
ResetDismissalApps()
ResetDismissalTeams()
ResetDismissalUsers()
ResetDismissStaleReviews()
ResetIncludeAdmins()
ResetRequireCodeOwnerReviews()
ResetRequiredApprovingReviewCount()
ResetRequireLastPushApproval()
// 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 NewBranchProtectionV3RequiredPullRequestReviewsOutputReference ¶
func NewBranchProtectionV3RequiredPullRequestReviewsOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) BranchProtectionV3RequiredPullRequestReviewsOutputReference
type BranchProtectionV3RequiredStatusChecks ¶
type BranchProtectionV3RequiredStatusChecks struct {
// The list of status checks to require in order to merge into this branch.
//
// No status checks are required by default. Checks should be strings containing the 'context' and 'app_id' like so 'context:app_id'
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3#checks BranchProtectionV3#checks}
Checks *[]*string `field:"optional" json:"checks" yaml:"checks"`
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3#contexts BranchProtectionV3#contexts}.
Contexts *[]*string `field:"optional" json:"contexts" yaml:"contexts"`
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3#include_admins BranchProtectionV3#include_admins}.
IncludeAdmins interface{} `field:"optional" json:"includeAdmins" yaml:"includeAdmins"`
// Require branches to be up to date before merging.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3#strict BranchProtectionV3#strict}
Strict interface{} `field:"optional" json:"strict" yaml:"strict"`
}
type BranchProtectionV3RequiredStatusChecksOutputReference ¶
type BranchProtectionV3RequiredStatusChecksOutputReference interface {
cdktf.ComplexObject
Checks() *[]*string
SetChecks(val *[]*string)
ChecksInput() *[]*string
// 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
IncludeAdmins() interface{}
SetIncludeAdmins(val interface{})
IncludeAdminsInput() interface{}
InternalValue() *BranchProtectionV3RequiredStatusChecks
SetInternalValue(val *BranchProtectionV3RequiredStatusChecks)
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
ResetChecks()
ResetContexts()
ResetIncludeAdmins()
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 NewBranchProtectionV3RequiredStatusChecksOutputReference ¶
func NewBranchProtectionV3RequiredStatusChecksOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) BranchProtectionV3RequiredStatusChecksOutputReference
type BranchProtectionV3Restrictions ¶
type BranchProtectionV3Restrictions struct {
// The list of app slugs with push access.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3#apps BranchProtectionV3#apps}
Apps *[]*string `field:"optional" json:"apps" yaml:"apps"`
// The list of team slugs with push access.
//
// Always use slug of the team, not its name. Each team already has to have access to the repository.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3#teams BranchProtectionV3#teams}
Teams *[]*string `field:"optional" json:"teams" yaml:"teams"`
// The list of user logins with push access.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.1/docs/resources/branch_protection_v3#users BranchProtectionV3#users}
Users *[]*string `field:"optional" json:"users" yaml:"users"`
}
type BranchProtectionV3RestrictionsOutputReference ¶
type BranchProtectionV3RestrictionsOutputReference interface {
cdktf.ComplexObject
Apps() *[]*string
SetApps(val *[]*string)
AppsInput() *[]*string
// 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
// Experimental.
Fqn() *string
InternalValue() *BranchProtectionV3Restrictions
SetInternalValue(val *BranchProtectionV3Restrictions)
Teams() *[]*string
SetTeams(val *[]*string)
TeamsInput() *[]*string
// Experimental.
TerraformAttribute() *string
// Experimental.
SetTerraformAttribute(val *string)
// Experimental.
TerraformResource() cdktf.IInterpolatingParent
// Experimental.
SetTerraformResource(val cdktf.IInterpolatingParent)
Users() *[]*string
SetUsers(val *[]*string)
UsersInput() *[]*string
// 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
ResetApps()
ResetTeams()
ResetUsers()
// 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 NewBranchProtectionV3RestrictionsOutputReference ¶
func NewBranchProtectionV3RestrictionsOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) BranchProtectionV3RestrictionsOutputReference
Source Files
¶
- BranchProtectionV3.go
- BranchProtectionV3Config.go
- BranchProtectionV3RequiredPullRequestReviews.go
- BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowances.go
- BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference.go
- BranchProtectionV3RequiredPullRequestReviewsBypassPullRequestAllowancesOutputReference__checks.go
- BranchProtectionV3RequiredPullRequestReviewsOutputReference.go
- BranchProtectionV3RequiredPullRequestReviewsOutputReference__checks.go
- BranchProtectionV3RequiredStatusChecks.go
- BranchProtectionV3RequiredStatusChecksOutputReference.go
- BranchProtectionV3RequiredStatusChecksOutputReference__checks.go
- BranchProtectionV3Restrictions.go
- BranchProtectionV3RestrictionsOutputReference.go
- BranchProtectionV3RestrictionsOutputReference__checks.go
- BranchProtectionV3__checks.go
- main.go