GitHub

v5.0.0 published on Thursday, Sep 22, 2022 by Pulumi

BranchProtectionV3

Create a BranchProtectionV3 Resource

new BranchProtectionV3(name: string, args: BranchProtectionV3Args, opts?: CustomResourceOptions);
@overload
def BranchProtectionV3(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       branch: Optional[str] = None,
                       enforce_admins: Optional[bool] = None,
                       repository: Optional[str] = None,
                       require_conversation_resolution: Optional[bool] = None,
                       require_signed_commits: Optional[bool] = None,
                       required_pull_request_reviews: Optional[BranchProtectionV3RequiredPullRequestReviewsArgs] = None,
                       required_status_checks: Optional[BranchProtectionV3RequiredStatusChecksArgs] = None,
                       restrictions: Optional[BranchProtectionV3RestrictionsArgs] = None)
@overload
def BranchProtectionV3(resource_name: str,
                       args: BranchProtectionV3Args,
                       opts: Optional[ResourceOptions] = None)
func NewBranchProtectionV3(ctx *Context, name string, args BranchProtectionV3Args, opts ...ResourceOption) (*BranchProtectionV3, error)
public BranchProtectionV3(string name, BranchProtectionV3Args args, CustomResourceOptions? opts = null)
public BranchProtectionV3(String name, BranchProtectionV3Args args)
public BranchProtectionV3(String name, BranchProtectionV3Args args, CustomResourceOptions options)
type: github:BranchProtectionV3
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args BranchProtectionV3Args
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args BranchProtectionV3Args
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args BranchProtectionV3Args
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BranchProtectionV3Args
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args BranchProtectionV3Args
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

BranchProtectionV3 Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The BranchProtectionV3 resource accepts the following input properties:

Outputs

All input properties are implicitly available as output properties. Additionally, the BranchProtectionV3 resource produces the following output properties:

Etag string
Id string

The provider-assigned unique ID for this managed resource.

Etag string
Id string

The provider-assigned unique ID for this managed resource.

etag String
id String

The provider-assigned unique ID for this managed resource.

etag string
id string

The provider-assigned unique ID for this managed resource.

etag str
id str

The provider-assigned unique ID for this managed resource.

etag String
id String

The provider-assigned unique ID for this managed resource.

Look up an Existing BranchProtectionV3 Resource

Get an existing BranchProtectionV3 resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: BranchProtectionV3State, opts?: CustomResourceOptions): BranchProtectionV3
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        branch: Optional[str] = None,
        enforce_admins: Optional[bool] = None,
        etag: Optional[str] = None,
        repository: Optional[str] = None,
        require_conversation_resolution: Optional[bool] = None,
        require_signed_commits: Optional[bool] = None,
        required_pull_request_reviews: Optional[BranchProtectionV3RequiredPullRequestReviewsArgs] = None,
        required_status_checks: Optional[BranchProtectionV3RequiredStatusChecksArgs] = None,
        restrictions: Optional[BranchProtectionV3RestrictionsArgs] = None) -> BranchProtectionV3
func GetBranchProtectionV3(ctx *Context, name string, id IDInput, state *BranchProtectionV3State, opts ...ResourceOption) (*BranchProtectionV3, error)
public static BranchProtectionV3 Get(string name, Input<string> id, BranchProtectionV3State? state, CustomResourceOptions? opts = null)
public static BranchProtectionV3 get(String name, Output<String> id, BranchProtectionV3State state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:

Supporting Types

BranchProtectionV3RequiredPullRequestReviews

DismissStaleReviews bool
DismissalTeams List<string>
DismissalUsers List<string>
IncludeAdmins bool

Deprecated:

Use enforce_admins instead

RequireCodeOwnerReviews bool
RequiredApprovingReviewCount int
DismissStaleReviews bool
DismissalTeams []string
DismissalUsers []string
IncludeAdmins bool

Deprecated:

Use enforce_admins instead

RequireCodeOwnerReviews bool
RequiredApprovingReviewCount int
dismissStaleReviews Boolean
dismissalTeams List<String>
dismissalUsers List<String>
includeAdmins Boolean

Deprecated:

Use enforce_admins instead

requireCodeOwnerReviews Boolean
requiredApprovingReviewCount Integer
dismissStaleReviews boolean
dismissalTeams string[]
dismissalUsers string[]
includeAdmins boolean

Deprecated:

Use enforce_admins instead

requireCodeOwnerReviews boolean
requiredApprovingReviewCount number
dismiss_stale_reviews bool
dismissal_teams Sequence[str]
dismissal_users Sequence[str]
include_admins bool

Deprecated:

Use enforce_admins instead

require_code_owner_reviews bool
required_approving_review_count int
dismissStaleReviews Boolean
dismissalTeams List<String>
dismissalUsers List<String>
includeAdmins Boolean

Deprecated:

Use enforce_admins instead

requireCodeOwnerReviews Boolean
requiredApprovingReviewCount Number

BranchProtectionV3RequiredStatusChecks

Contexts List<string>
IncludeAdmins bool

Deprecated:

Use enforce_admins instead

Strict bool
Contexts []string
IncludeAdmins bool

Deprecated:

Use enforce_admins instead

Strict bool
contexts List<String>
includeAdmins Boolean

Deprecated:

Use enforce_admins instead

strict Boolean
contexts string[]
includeAdmins boolean

Deprecated:

Use enforce_admins instead

strict boolean
contexts Sequence[str]
include_admins bool

Deprecated:

Use enforce_admins instead

strict bool
contexts List<String>
includeAdmins Boolean

Deprecated:

Use enforce_admins instead

strict Boolean

BranchProtectionV3Restrictions

Apps List<string>
Teams List<string>
Users List<string>
Apps []string
Teams []string
Users []string
apps List<String>
teams List<String>
users List<String>
apps string[]
teams string[]
users string[]
apps Sequence[str]
teams Sequence[str]
users Sequence[str]
apps List<String>
teams List<String>
users List<String>

Package Details

Repository
https://github.com/pulumi/pulumi-github
License
Apache-2.0
Notes

This Pulumi package is based on the github Terraform Provider.