Skip to content

Latest commit

 

History

History
2137 lines (1359 loc) · 104 KB

secureSourceManagerBranchRule.python.md

File metadata and controls

2137 lines (1359 loc) · 104 KB
Raw

secureSourceManagerBranchRule Submodule

Constructs

SecureSourceManagerBranchRule

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule google_secure_source_manager_branch_rule}.

Initializers 

from cdktf_cdktf_provider_google import secure_source_manager_branch_rule

secureSourceManagerBranchRule.SecureSourceManagerBranchRule(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  branch_rule_id: str,
  include_pattern: str,
  location: str,
  repository_id: str,
  allow_stale_reviews: typing.Union[bool, IResolvable] = None,
  disabled: typing.Union[bool, IResolvable] = None,
  id: str = None,
  minimum_approvals_count: typing.Union[int, float] = None,
  minimum_reviews_count: typing.Union[int, float] = None,
  project: str = None,
  require_comments_resolved: typing.Union[bool, IResolvable] = None,
  require_linear_history: typing.Union[bool, IResolvable] = None,
  require_pull_request: typing.Union[bool, IResolvable] = None,
  timeouts: SecureSourceManagerBranchRuleTimeouts = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
branch_rule_id str The ID for the BranchRule.
include_pattern str The BranchRule matches branches based on the specified regular expression. Use .* to match all branches.
location str The location for the Repository.
repository_id str The ID for the Repository.
allow_stale_reviews typing.Union[bool, cdktf.IResolvable] Determines if allow stale reviews or approvals before merging to the branch.
disabled typing.Union[bool, cdktf.IResolvable] Determines if the branch rule is disabled or not.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#id SecureSourceManagerBranchRule#id}.
minimum_approvals_count typing.Union[int, float] The minimum number of approvals required for the branch rule to be matched.
minimum_reviews_count typing.Union[int, float] The minimum number of reviews required for the branch rule to be matched.
project str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#project SecureSourceManagerBranchRule#project}.
require_comments_resolved typing.Union[bool, cdktf.IResolvable] Determines if require comments resolved before merging to the branch.
require_linear_history typing.Union[bool, cdktf.IResolvable] Determines if require linear history before merging to the branch.
require_pull_request typing.Union[bool, cdktf.IResolvable] Determines if the branch rule requires a pull request or not.
timeouts SecureSourceManagerBranchRuleTimeouts timeouts block.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
branch_rule_idRequired
  • Type: str

The ID for the BranchRule.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#branch_rule_id SecureSourceManagerBranchRule#branch_rule_id}

include_patternRequired
  • Type: str

The BranchRule matches branches based on the specified regular expression. Use .* to match all branches.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#include_pattern SecureSourceManagerBranchRule#include_pattern}

locationRequired
  • Type: str

The location for the Repository.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#location SecureSourceManagerBranchRule#location}

repository_idRequired
  • Type: str

The ID for the Repository.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#repository_id SecureSourceManagerBranchRule#repository_id}

allow_stale_reviewsOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Determines if allow stale reviews or approvals before merging to the branch.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#allow_stale_reviews SecureSourceManagerBranchRule#allow_stale_reviews}

disabledOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Determines if the branch rule is disabled or not.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#disabled SecureSourceManagerBranchRule#disabled}

idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#id SecureSourceManagerBranchRule#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.

minimum_approvals_countOptional
  • Type: typing.Union[int, float]

The minimum number of approvals required for the branch rule to be matched.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#minimum_approvals_count SecureSourceManagerBranchRule#minimum_approvals_count}

minimum_reviews_countOptional
  • Type: typing.Union[int, float]

The minimum number of reviews required for the branch rule to be matched.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#minimum_reviews_count SecureSourceManagerBranchRule#minimum_reviews_count}

projectOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#project SecureSourceManagerBranchRule#project}.

require_comments_resolvedOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Determines if require comments resolved before merging to the branch.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#require_comments_resolved SecureSourceManagerBranchRule#require_comments_resolved}

require_linear_historyOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Determines if require linear history before merging to the branch.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#require_linear_history SecureSourceManagerBranchRule#require_linear_history}

require_pull_requestOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Determines if the branch rule requires a pull request or not.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#require_pull_request SecureSourceManagerBranchRule#require_pull_request}

timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#timeouts SecureSourceManagerBranchRule#timeouts}

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
put_timeouts No description.
reset_allow_stale_reviews No description.
reset_disabled No description.
reset_id No description.
reset_minimum_approvals_count No description.
reset_minimum_reviews_count No description.
reset_project No description.
reset_require_comments_resolved No description.
reset_require_linear_history No description.
reset_require_pull_request No description.
reset_timeouts No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

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

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

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

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: str

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

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

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

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

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

move_to_id 
def move_to_id(
  id: str
) -> None

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

idRequired
  • Type: str

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

put_timeouts 
def put_timeouts(
  create: str = None,
  delete: str = None,
  update: str = None
) -> None
createOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#create SecureSourceManagerBranchRule#create}.

deleteOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#delete SecureSourceManagerBranchRule#delete}.

updateOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#update SecureSourceManagerBranchRule#update}.

reset_allow_stale_reviews 
def reset_allow_stale_reviews() -> None
reset_disabled 
def reset_disabled() -> None
reset_id 
def reset_id() -> None
reset_minimum_approvals_count 
def reset_minimum_approvals_count() -> None
reset_minimum_reviews_count 
def reset_minimum_reviews_count() -> None
reset_project 
def reset_project() -> None
reset_require_comments_resolved 
def reset_require_comments_resolved() -> None
reset_require_linear_history 
def reset_require_linear_history() -> None
reset_require_pull_request 
def reset_require_pull_request() -> None
reset_timeouts 
def reset_timeouts() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a SecureSourceManagerBranchRule resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_google import secure_source_manager_branch_rule

secureSourceManagerBranchRule.SecureSourceManagerBranchRule.is_construct(
  x: typing.Any
)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_google import secure_source_manager_branch_rule

secureSourceManagerBranchRule.SecureSourceManagerBranchRule.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_google import secure_source_manager_branch_rule

secureSourceManagerBranchRule.SecureSourceManagerBranchRule.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_google import secure_source_manager_branch_rule

secureSourceManagerBranchRule.SecureSourceManagerBranchRule.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

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

import_from_idRequired
  • Type: str

The id of the existing SecureSourceManagerBranchRule that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktf.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
create_time str No description.
name str No description.
timeouts SecureSourceManagerBranchRuleTimeoutsOutputReference No description.
uid str No description.
update_time str No description.
allow_stale_reviews_input typing.Union[bool, cdktf.IResolvable] No description.
branch_rule_id_input str No description.
disabled_input typing.Union[bool, cdktf.IResolvable] No description.
id_input str No description.
include_pattern_input str No description.
location_input str No description.
minimum_approvals_count_input typing.Union[int, float] No description.
minimum_reviews_count_input typing.Union[int, float] No description.
project_input str No description.
repository_id_input str No description.
require_comments_resolved_input typing.Union[bool, cdktf.IResolvable] No description.
require_linear_history_input typing.Union[bool, cdktf.IResolvable] No description.
require_pull_request_input typing.Union[bool, cdktf.IResolvable] No description.
timeouts_input typing.Union[cdktf.IResolvable, SecureSourceManagerBranchRuleTimeouts] No description.
allow_stale_reviews typing.Union[bool, cdktf.IResolvable] No description.
branch_rule_id str No description.
disabled typing.Union[bool, cdktf.IResolvable] No description.
id str No description.
include_pattern str No description.
location str No description.
minimum_approvals_count typing.Union[int, float] No description.
minimum_reviews_count typing.Union[int, float] No description.
project str No description.
repository_id str No description.
require_comments_resolved typing.Union[bool, cdktf.IResolvable] No description.
require_linear_history typing.Union[bool, cdktf.IResolvable] No description.
require_pull_request typing.Union[bool, cdktf.IResolvable] No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
create_timeRequired 
create_time: str
  • Type: str
nameRequired 
name: str
  • Type: str
timeoutsRequired 
timeouts: SecureSourceManagerBranchRuleTimeoutsOutputReference
uidRequired 
uid: str
  • Type: str
update_timeRequired 
update_time: str
  • Type: str
allow_stale_reviews_inputOptional 
allow_stale_reviews_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
branch_rule_id_inputOptional 
branch_rule_id_input: str
  • Type: str
disabled_inputOptional 
disabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
id_inputOptional 
id_input: str
  • Type: str
include_pattern_inputOptional 
include_pattern_input: str
  • Type: str
location_inputOptional 
location_input: str
  • Type: str
minimum_approvals_count_inputOptional 
minimum_approvals_count_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
minimum_reviews_count_inputOptional 
minimum_reviews_count_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
project_inputOptional 
project_input: str
  • Type: str
repository_id_inputOptional 
repository_id_input: str
  • Type: str
require_comments_resolved_inputOptional 
require_comments_resolved_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
require_linear_history_inputOptional 
require_linear_history_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
require_pull_request_inputOptional 
require_pull_request_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
timeouts_inputOptional 
timeouts_input: typing.Union[IResolvable, SecureSourceManagerBranchRuleTimeouts]
allow_stale_reviewsRequired 
allow_stale_reviews: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
branch_rule_idRequired 
branch_rule_id: str
  • Type: str
disabledRequired 
disabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
idRequired 
id: str
  • Type: str
include_patternRequired 
include_pattern: str
  • Type: str
locationRequired 
location: str
  • Type: str
minimum_approvals_countRequired 
minimum_approvals_count: typing.Union[int, float]
  • Type: typing.Union[int, float]
minimum_reviews_countRequired 
minimum_reviews_count: typing.Union[int, float]
  • Type: typing.Union[int, float]
projectRequired 
project: str
  • Type: str
repository_idRequired 
repository_id: str
  • Type: str
require_comments_resolvedRequired 
require_comments_resolved: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
require_linear_historyRequired 
require_linear_history: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
require_pull_requestRequired 
require_pull_request: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

SecureSourceManagerBranchRuleConfig

Initializer 

from cdktf_cdktf_provider_google import secure_source_manager_branch_rule

secureSourceManagerBranchRule.SecureSourceManagerBranchRuleConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  branch_rule_id: str,
  include_pattern: str,
  location: str,
  repository_id: str,
  allow_stale_reviews: typing.Union[bool, IResolvable] = None,
  disabled: typing.Union[bool, IResolvable] = None,
  id: str = None,
  minimum_approvals_count: typing.Union[int, float] = None,
  minimum_reviews_count: typing.Union[int, float] = None,
  project: str = None,
  require_comments_resolved: typing.Union[bool, IResolvable] = None,
  require_linear_history: typing.Union[bool, IResolvable] = None,
  require_pull_request: typing.Union[bool, IResolvable] = None,
  timeouts: SecureSourceManagerBranchRuleTimeouts = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
branch_rule_id str The ID for the BranchRule.
include_pattern str The BranchRule matches branches based on the specified regular expression. Use .* to match all branches.
location str The location for the Repository.
repository_id str The ID for the Repository.
allow_stale_reviews typing.Union[bool, cdktf.IResolvable] Determines if allow stale reviews or approvals before merging to the branch.
disabled typing.Union[bool, cdktf.IResolvable] Determines if the branch rule is disabled or not.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#id SecureSourceManagerBranchRule#id}.
minimum_approvals_count typing.Union[int, float] The minimum number of approvals required for the branch rule to be matched.
minimum_reviews_count typing.Union[int, float] The minimum number of reviews required for the branch rule to be matched.
project str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#project SecureSourceManagerBranchRule#project}.
require_comments_resolved typing.Union[bool, cdktf.IResolvable] Determines if require comments resolved before merging to the branch.
require_linear_history typing.Union[bool, cdktf.IResolvable] Determines if require linear history before merging to the branch.
require_pull_request typing.Union[bool, cdktf.IResolvable] Determines if the branch rule requires a pull request or not.
timeouts SecureSourceManagerBranchRuleTimeouts timeouts block.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
branch_rule_idRequired 
branch_rule_id: str
  • Type: str

The ID for the BranchRule.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#branch_rule_id SecureSourceManagerBranchRule#branch_rule_id}

include_patternRequired 
include_pattern: str
  • Type: str

The BranchRule matches branches based on the specified regular expression. Use .* to match all branches.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#include_pattern SecureSourceManagerBranchRule#include_pattern}

locationRequired 
location: str
  • Type: str

The location for the Repository.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#location SecureSourceManagerBranchRule#location}

repository_idRequired 
repository_id: str
  • Type: str

The ID for the Repository.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#repository_id SecureSourceManagerBranchRule#repository_id}

allow_stale_reviewsOptional 
allow_stale_reviews: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Determines if allow stale reviews or approvals before merging to the branch.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#allow_stale_reviews SecureSourceManagerBranchRule#allow_stale_reviews}

disabledOptional 
disabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Determines if the branch rule is disabled or not.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#disabled SecureSourceManagerBranchRule#disabled}

idOptional 
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#id SecureSourceManagerBranchRule#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.

minimum_approvals_countOptional 
minimum_approvals_count: typing.Union[int, float]
  • Type: typing.Union[int, float]

The minimum number of approvals required for the branch rule to be matched.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#minimum_approvals_count SecureSourceManagerBranchRule#minimum_approvals_count}

minimum_reviews_countOptional 
minimum_reviews_count: typing.Union[int, float]
  • Type: typing.Union[int, float]

The minimum number of reviews required for the branch rule to be matched.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#minimum_reviews_count SecureSourceManagerBranchRule#minimum_reviews_count}

projectOptional 
project: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#project SecureSourceManagerBranchRule#project}.

require_comments_resolvedOptional 
require_comments_resolved: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Determines if require comments resolved before merging to the branch.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#require_comments_resolved SecureSourceManagerBranchRule#require_comments_resolved}

require_linear_historyOptional 
require_linear_history: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Determines if require linear history before merging to the branch.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#require_linear_history SecureSourceManagerBranchRule#require_linear_history}

require_pull_requestOptional 
require_pull_request: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Determines if the branch rule requires a pull request or not.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#require_pull_request SecureSourceManagerBranchRule#require_pull_request}

timeoutsOptional 
timeouts: SecureSourceManagerBranchRuleTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#timeouts SecureSourceManagerBranchRule#timeouts}

SecureSourceManagerBranchRuleTimeouts

Initializer 

from cdktf_cdktf_provider_google import secure_source_manager_branch_rule

secureSourceManagerBranchRule.SecureSourceManagerBranchRuleTimeouts(
  create: str = None,
  delete: str = None,
  update: str = None
)

Properties

Name Type Description
create str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#create SecureSourceManagerBranchRule#create}.
delete str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#delete SecureSourceManagerBranchRule#delete}.
update str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#update SecureSourceManagerBranchRule#update}.
createOptional 
create: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#create SecureSourceManagerBranchRule#create}.

deleteOptional 
delete: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#delete SecureSourceManagerBranchRule#delete}.

updateOptional 
update: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/secure_source_manager_branch_rule#update SecureSourceManagerBranchRule#update}.

Classes

SecureSourceManagerBranchRuleTimeoutsOutputReference

Initializers 

from cdktf_cdktf_provider_google import secure_source_manager_branch_rule

secureSourceManagerBranchRule.SecureSourceManagerBranchRuleTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_create No description.
reset_delete No description.
reset_update No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_create 
def reset_create() -> None
reset_delete 
def reset_delete() -> None
reset_update 
def reset_update() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
create_input str No description.
delete_input str No description.
update_input str No description.
create str No description.
delete str No description.
update str No description.
internal_value typing.Union[cdktf.IResolvable, SecureSourceManagerBranchRuleTimeouts] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
create_inputOptional 
create_input: str
  • Type: str
delete_inputOptional 
delete_input: str
  • Type: str
update_inputOptional 
update_input: str
  • Type: str
createRequired 
create: str
  • Type: str
deleteRequired 
delete: str
  • Type: str
updateRequired 
update: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, SecureSourceManagerBranchRuleTimeouts]