Skip to content

repositoryEnvironment.python.md

Latest commit

 

History

History
2326 lines (1478 loc) · 106 KB

repositoryEnvironment.python.md

File metadata and controls

2326 lines (1478 loc) · 106 KB

repositoryEnvironment Submodule

Constructs

RepositoryEnvironment

Represents a {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment github_repository_environment}.

Initializers 

from cdktn_provider_github import repository_environment

repositoryEnvironment.RepositoryEnvironment(
  scope: Construct,
  id: str,
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: 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[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  environment: str,
  repository: str,
  can_admins_bypass: bool | IResolvable = None,
  deployment_branch_policy: RepositoryEnvironmentDeploymentBranchPolicy = None,
  id: str = None,
  prevent_self_review: bool | IResolvable = None,
  reviewers: IResolvable | typing.List[RepositoryEnvironmentReviewers] = None,
  wait_timer: typing.Union[int, float] = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[cdktn.ITerraformDependable] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
environment str The name of the environment.
repository str The repository of the environment.
can_admins_bypass bool | cdktn.IResolvable Can Admins bypass deployment protections.
deployment_branch_policy RepositoryEnvironmentDeploymentBranchPolicy deployment_branch_policy block.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#id RepositoryEnvironment#id}.
prevent_self_review bool | cdktn.IResolvable Prevent users from approving workflows runs that they triggered.
reviewers cdktn.IResolvable | typing.List[RepositoryEnvironmentReviewers] reviewers block.
wait_timer typing.Union[int, float] Amount of time to delay a job after the job is initially triggered.
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: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional
  • Type: typing.Union[int, float] | cdktn.TerraformCount
depends_onOptional
  • Type: typing.List[cdktn.ITerraformDependable]
for_eachOptional
  • Type: cdktn.ITerraformIterator
lifecycleOptional
  • Type: cdktn.TerraformResourceLifecycle
providerOptional
  • Type: cdktn.TerraformProvider
provisionersOptional
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
environmentRequired
  • Type: str

The name of the environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#environment RepositoryEnvironment#environment}

repositoryRequired
  • Type: str

The repository of the environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#repository RepositoryEnvironment#repository}

can_admins_bypassOptional
  • Type: bool | cdktn.IResolvable

Can Admins bypass deployment protections.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#can_admins_bypass RepositoryEnvironment#can_admins_bypass}

deployment_branch_policyOptional

deployment_branch_policy block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#deployment_branch_policy RepositoryEnvironment#deployment_branch_policy}

idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#id RepositoryEnvironment#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.

prevent_self_reviewOptional
  • Type: bool | cdktn.IResolvable

Prevent users from approving workflows runs that they triggered.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#prevent_self_review RepositoryEnvironment#prevent_self_review}

reviewersOptional

reviewers block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#reviewers RepositoryEnvironment#reviewers}

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

Amount of time to delay a job after the job is initially triggered.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#wait_timer RepositoryEnvironment#wait_timer}

Methods

Name Description
to_string Returns a string representation of this construct.
with Applies one or more mixins to 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_deployment_branch_policy No description.
put_reviewers No description.
reset_can_admins_bypass No description.
reset_deployment_branch_policy No description.
reset_id No description.
reset_prevent_self_review No description.
reset_reviewers No description.
reset_wait_timer No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

with 
def with(
  mixins: *IMixin
) -> IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixinsRequired
  • Type: *constructs.IMixin

The mixins to apply.

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() -> TerraformResourceMoveByTarget | TerraformResourceMoveById
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktn.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: 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: 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_deployment_branch_policy 
def put_deployment_branch_policy(
  custom_branch_policies: bool | IResolvable,
  protected_branches: bool | IResolvable
) -> None
custom_branch_policiesRequired
  • Type: bool | cdktn.IResolvable

Whether only branches that match the specified name patterns can deploy to this environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#custom_branch_policies RepositoryEnvironment#custom_branch_policies}

protected_branchesRequired
  • Type: bool | cdktn.IResolvable

Whether only branches with branch protection rules can deploy to this environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#protected_branches RepositoryEnvironment#protected_branches}

put_reviewers 
def put_reviewers(
  value: IResolvable | typing.List[RepositoryEnvironmentReviewers]
) -> None
valueRequired
reset_can_admins_bypass 
def reset_can_admins_bypass() -> None
reset_deployment_branch_policy 
def reset_deployment_branch_policy() -> None
reset_id 
def reset_id() -> None
reset_prevent_self_review 
def reset_prevent_self_review() -> None
reset_reviewers 
def reset_reviewers() -> None
reset_wait_timer 
def reset_wait_timer() -> 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 CDKTN code for importing a RepositoryEnvironment resource upon running "cdktn plan ".
is_construct 
from cdktn_provider_github import repository_environment

repositoryEnvironment.RepositoryEnvironment.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 cdktn_provider_github import repository_environment

repositoryEnvironment.RepositoryEnvironment.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktn_provider_github import repository_environment

repositoryEnvironment.RepositoryEnvironment.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktn_provider_github import repository_environment

repositoryEnvironment.RepositoryEnvironment.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTN code for importing a RepositoryEnvironment resource upon running "cdktn 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 RepositoryEnvironment to import.

import_from_idRequired
  • Type: str

The id of the existing RepositoryEnvironment that should be imported.

Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktn.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktn.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 cdktn.TerraformProviderGeneratorMetadata No description.
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[str] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
deployment_branch_policy RepositoryEnvironmentDeploymentBranchPolicyOutputReference No description.
reviewers RepositoryEnvironmentReviewersList No description.
can_admins_bypass_input bool | cdktn.IResolvable No description.
deployment_branch_policy_input RepositoryEnvironmentDeploymentBranchPolicy No description.
environment_input str No description.
id_input str No description.
prevent_self_review_input bool | cdktn.IResolvable No description.
repository_input str No description.
reviewers_input cdktn.IResolvable | typing.List[RepositoryEnvironmentReviewers] No description.
wait_timer_input typing.Union[int, float] No description.
can_admins_bypass bool | cdktn.IResolvable No description.
environment str No description.
id str No description.
prevent_self_review bool | cdktn.IResolvable No description.
repository str No description.
wait_timer typing.Union[int, float] No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktn.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: cdktn.TerraformProviderGeneratorMetadata
connectionOptional 
connection: SSHProvisionerConnection | WinrmProvisionerConnection
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional 
count: typing.Union[int, float] | TerraformCount
  • Type: typing.Union[int, float] | cdktn.TerraformCount
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktn.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktn.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktn.TerraformProvider
provisionersOptional 
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
deployment_branch_policyRequired 
deployment_branch_policy: RepositoryEnvironmentDeploymentBranchPolicyOutputReference
reviewersRequired 
reviewers: RepositoryEnvironmentReviewersList
can_admins_bypass_inputOptional 
can_admins_bypass_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
deployment_branch_policy_inputOptional 
deployment_branch_policy_input: RepositoryEnvironmentDeploymentBranchPolicy
environment_inputOptional 
environment_input: str
  • Type: str
id_inputOptional 
id_input: str
  • Type: str
prevent_self_review_inputOptional 
prevent_self_review_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
repository_inputOptional 
repository_input: str
  • Type: str
reviewers_inputOptional 
reviewers_input: IResolvable | typing.List[RepositoryEnvironmentReviewers]
wait_timer_inputOptional 
wait_timer_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
can_admins_bypassRequired 
can_admins_bypass: bool | IResolvable
  • Type: bool | cdktn.IResolvable
environmentRequired 
environment: str
  • Type: str
idRequired 
id: str
  • Type: str
prevent_self_reviewRequired 
prevent_self_review: bool | IResolvable
  • Type: bool | cdktn.IResolvable
repositoryRequired 
repository: str
  • Type: str
wait_timerRequired 
wait_timer: typing.Union[int, float]
  • Type: typing.Union[int, float]

Constants

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

Structs

RepositoryEnvironmentConfig

Initializer 

from cdktn_provider_github import repository_environment

repositoryEnvironment.RepositoryEnvironmentConfig(
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: 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[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  environment: str,
  repository: str,
  can_admins_bypass: bool | IResolvable = None,
  deployment_branch_policy: RepositoryEnvironmentDeploymentBranchPolicy = None,
  id: str = None,
  prevent_self_review: bool | IResolvable = None,
  reviewers: IResolvable | typing.List[RepositoryEnvironmentReviewers] = None,
  wait_timer: typing.Union[int, float] = None
)

Properties

Name Type Description
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[cdktn.ITerraformDependable] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
environment str The name of the environment.
repository str The repository of the environment.
can_admins_bypass bool | cdktn.IResolvable Can Admins bypass deployment protections.
deployment_branch_policy RepositoryEnvironmentDeploymentBranchPolicy deployment_branch_policy block.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#id RepositoryEnvironment#id}.
prevent_self_review bool | cdktn.IResolvable Prevent users from approving workflows runs that they triggered.
reviewers cdktn.IResolvable | typing.List[RepositoryEnvironmentReviewers] reviewers block.
wait_timer typing.Union[int, float] Amount of time to delay a job after the job is initially triggered.
connectionOptional 
connection: SSHProvisionerConnection | WinrmProvisionerConnection
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional 
count: typing.Union[int, float] | TerraformCount
  • Type: typing.Union[int, float] | cdktn.TerraformCount
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktn.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktn.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktn.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktn.TerraformProvider
provisionersOptional 
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
environmentRequired 
environment: str
  • Type: str

The name of the environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#environment RepositoryEnvironment#environment}

repositoryRequired 
repository: str
  • Type: str

The repository of the environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#repository RepositoryEnvironment#repository}

can_admins_bypassOptional 
can_admins_bypass: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Can Admins bypass deployment protections.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#can_admins_bypass RepositoryEnvironment#can_admins_bypass}

deployment_branch_policyOptional 
deployment_branch_policy: RepositoryEnvironmentDeploymentBranchPolicy

deployment_branch_policy block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#deployment_branch_policy RepositoryEnvironment#deployment_branch_policy}

idOptional 
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#id RepositoryEnvironment#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.

prevent_self_reviewOptional 
prevent_self_review: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Prevent users from approving workflows runs that they triggered.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#prevent_self_review RepositoryEnvironment#prevent_self_review}

reviewersOptional 
reviewers: IResolvable | typing.List[RepositoryEnvironmentReviewers]

reviewers block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#reviewers RepositoryEnvironment#reviewers}

wait_timerOptional 
wait_timer: typing.Union[int, float]
  • Type: typing.Union[int, float]

Amount of time to delay a job after the job is initially triggered.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#wait_timer RepositoryEnvironment#wait_timer}

RepositoryEnvironmentDeploymentBranchPolicy

Initializer 

from cdktn_provider_github import repository_environment

repositoryEnvironment.RepositoryEnvironmentDeploymentBranchPolicy(
  custom_branch_policies: bool | IResolvable,
  protected_branches: bool | IResolvable
)

Properties

Name Type Description
custom_branch_policies bool | cdktn.IResolvable Whether only branches that match the specified name patterns can deploy to this environment.
protected_branches bool | cdktn.IResolvable Whether only branches with branch protection rules can deploy to this environment.
custom_branch_policiesRequired 
custom_branch_policies: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Whether only branches that match the specified name patterns can deploy to this environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#custom_branch_policies RepositoryEnvironment#custom_branch_policies}

protected_branchesRequired 
protected_branches: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Whether only branches with branch protection rules can deploy to this environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#protected_branches RepositoryEnvironment#protected_branches}

RepositoryEnvironmentReviewers

Initializer 

from cdktn_provider_github import repository_environment

repositoryEnvironment.RepositoryEnvironmentReviewers(
  teams: typing.List[typing.Union[int, float]] = None,
  users: typing.List[typing.Union[int, float]] = None
)

Properties

Name Type Description
teams typing.List[typing.Union[int, float]] Up to 6 IDs for teams who may review jobs that reference the environment.
users typing.List[typing.Union[int, float]] Up to 6 IDs for users who may review jobs that reference the environment.
teamsOptional 
teams: typing.List[typing.Union[int, float]]
  • Type: typing.List[typing.Union[int, float]]

Up to 6 IDs for teams who may review jobs that reference the environment.

Reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#teams RepositoryEnvironment#teams}

usersOptional 
users: typing.List[typing.Union[int, float]]
  • Type: typing.List[typing.Union[int, float]]

Up to 6 IDs for users who may review jobs that reference the environment.

Reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.11.1/docs/resources/repository_environment#users RepositoryEnvironment#users}

Classes

RepositoryEnvironmentDeploymentBranchPolicyOutputReference

Initializers 

from cdktn_provider_github import repository_environment

repositoryEnvironment.RepositoryEnvironmentDeploymentBranchPolicyOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktn.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktn.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.
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: cdktn.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

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.
custom_branch_policies_input bool | cdktn.IResolvable No description.
protected_branches_input bool | cdktn.IResolvable No description.
custom_branch_policies bool | cdktn.IResolvable No description.
protected_branches bool | cdktn.IResolvable No description.
internal_value RepositoryEnvironmentDeploymentBranchPolicy 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
custom_branch_policies_inputOptional 
custom_branch_policies_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
protected_branches_inputOptional 
protected_branches_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
custom_branch_policiesRequired 
custom_branch_policies: bool | IResolvable
  • Type: bool | cdktn.IResolvable
protected_branchesRequired 
protected_branches: bool | IResolvable
  • Type: bool | cdktn.IResolvable
internal_valueOptional 
internal_value: RepositoryEnvironmentDeploymentBranchPolicy

RepositoryEnvironmentReviewersList

Initializers 

from cdktn_provider_github import repository_environment

repositoryEnvironment.RepositoryEnvironmentReviewersList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktn.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktn.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.
all_with_map_key 
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str
compute_fqn 
def compute_fqn() -> str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

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

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
def get(
  index: typing.Union[int, float]
) -> RepositoryEnvironmentReviewersOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.

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.
internal_value cdktn.IResolvable | typing.List[RepositoryEnvironmentReviewers] 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
internal_valueOptional 
internal_value: IResolvable | typing.List[RepositoryEnvironmentReviewers]

RepositoryEnvironmentReviewersOutputReference

Initializers 

from cdktn_provider_github import repository_environment

repositoryEnvironment.RepositoryEnvironmentReviewersOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktn.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktn.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

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

the index of this item in the list.

complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

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_teams No description.
reset_users 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: cdktn.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_teams 
def reset_teams() -> None
reset_users 
def reset_users() -> 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.
teams_input typing.List[typing.Union[int, float]] No description.
users_input typing.List[typing.Union[int, float]] No description.
teams typing.List[typing.Union[int, float]] No description.
users typing.List[typing.Union[int, float]] No description.
internal_value cdktn.IResolvable | RepositoryEnvironmentReviewers 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
teams_inputOptional 
teams_input: typing.List[typing.Union[int, float]]
  • Type: typing.List[typing.Union[int, float]]
users_inputOptional 
users_input: typing.List[typing.Union[int, float]]
  • Type: typing.List[typing.Union[int, float]]
teamsRequired 
teams: typing.List[typing.Union[int, float]]
  • Type: typing.List[typing.Union[int, float]]
usersRequired 
users: typing.List[typing.Union[int, float]]
  • Type: typing.List[typing.Union[int, float]]
internal_valueOptional 
internal_value: IResolvable | RepositoryEnvironmentReviewers