Skip to content

Latest commit

 

History

History
1582 lines (1002 loc) · 64.9 KB

repositoryFile.python.md

File metadata and controls

1582 lines (1002 loc) · 64.9 KB
Raw

repositoryFile Submodule

Constructs

RepositoryFile

Represents a {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file github_repository_file}.

Initializers 

from cdktf_cdktf_provider_github import repository_file

repositoryFile.RepositoryFile(
  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,
  content: str,
  file: str,
  repository: str,
  autocreate_branch: typing.Union[bool, IResolvable] = None,
  autocreate_branch_source_branch: str = None,
  autocreate_branch_source_sha: str = None,
  branch: str = None,
  commit_author: str = None,
  commit_email: str = None,
  commit_message: str = None,
  id: str = None,
  overwrite_on_create: typing.Union[bool, IResolvable] = 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.
content str The file's content.
file str The file path to manage.
repository str The repository name.
autocreate_branch typing.Union[bool, cdktf.IResolvable] Automatically create the branch if it could not be found.
autocreate_branch_source_branch str The branch name to start from, if 'autocreate_branch' is set. Defaults to 'main'.
autocreate_branch_source_sha str The commit hash to start from, if 'autocreate_branch' is set.
branch str The branch name, defaults to the repository's default branch.
commit_author str The commit author name, defaults to the authenticated user's name.
commit_email str The commit author email address, defaults to the authenticated user's email address.
commit_message str The commit message when creating, updating or deleting the file.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#id RepositoryFile#id}.
overwrite_on_create typing.Union[bool, cdktf.IResolvable] Enable overwriting existing files, defaults to "false".
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]]
contentRequired
  • Type: str

The file's content.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#content RepositoryFile#content}

fileRequired
  • Type: str

The file path to manage.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#file RepositoryFile#file}

repositoryRequired
  • Type: str

The repository name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#repository RepositoryFile#repository}

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

Automatically create the branch if it could not be found.

Subsequent reads if the branch is deleted will occur from 'autocreate_branch_source_branch'

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#autocreate_branch RepositoryFile#autocreate_branch}

autocreate_branch_source_branchOptional
  • Type: str

The branch name to start from, if 'autocreate_branch' is set. Defaults to 'main'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#autocreate_branch_source_branch RepositoryFile#autocreate_branch_source_branch}

autocreate_branch_source_shaOptional
  • Type: str

The commit hash to start from, if 'autocreate_branch' is set.

Defaults to the tip of 'autocreate_branch_source_branch'. If provided, 'autocreate_branch_source_branch' is ignored.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#autocreate_branch_source_sha RepositoryFile#autocreate_branch_source_sha}

branchOptional
  • Type: str

The branch name, defaults to the repository's default branch.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#branch RepositoryFile#branch}

commit_authorOptional
  • Type: str

The commit author name, defaults to the authenticated user's name.

GitHub app users may omit author and email information so GitHub can verify commits as the GitHub App.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#commit_author RepositoryFile#commit_author}

commit_emailOptional
  • Type: str

The commit author email address, defaults to the authenticated user's email address.

GitHub app users may omit author and email information so GitHub can verify commits as the GitHub App.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#commit_email RepositoryFile#commit_email}

commit_messageOptional
  • Type: str

The commit message when creating, updating or deleting the file.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#commit_message RepositoryFile#commit_message}

idOptional
  • Type: str

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

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

Enable overwriting existing files, defaults to "false".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#overwrite_on_create RepositoryFile#overwrite_on_create}

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".
reset_autocreate_branch No description.
reset_autocreate_branch_source_branch No description.
reset_autocreate_branch_source_sha No description.
reset_branch No description.
reset_commit_author No description.
reset_commit_email No description.
reset_commit_message No description.
reset_id No description.
reset_overwrite_on_create 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".

reset_autocreate_branch 
def reset_autocreate_branch() -> None
reset_autocreate_branch_source_branch 
def reset_autocreate_branch_source_branch() -> None
reset_autocreate_branch_source_sha 
def reset_autocreate_branch_source_sha() -> None
reset_branch 
def reset_branch() -> None
reset_commit_author 
def reset_commit_author() -> None
reset_commit_email 
def reset_commit_email() -> None
reset_commit_message 
def reset_commit_message() -> None
reset_id 
def reset_id() -> None
reset_overwrite_on_create 
def reset_overwrite_on_create() -> 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 RepositoryFile resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_github import repository_file

repositoryFile.RepositoryFile.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_github import repository_file

repositoryFile.RepositoryFile.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_github import repository_file

repositoryFile.RepositoryFile.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_github import repository_file

repositoryFile.RepositoryFile.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a RepositoryFile 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 RepositoryFile to import.

import_from_idRequired
  • Type: str

The id of the existing RepositoryFile that should be imported.

Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#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 RepositoryFile 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.
commit_sha str No description.
ref str No description.
sha str No description.
autocreate_branch_input typing.Union[bool, cdktf.IResolvable] No description.
autocreate_branch_source_branch_input str No description.
autocreate_branch_source_sha_input str No description.
branch_input str No description.
commit_author_input str No description.
commit_email_input str No description.
commit_message_input str No description.
content_input str No description.
file_input str No description.
id_input str No description.
overwrite_on_create_input typing.Union[bool, cdktf.IResolvable] No description.
repository_input str No description.
autocreate_branch typing.Union[bool, cdktf.IResolvable] No description.
autocreate_branch_source_branch str No description.
autocreate_branch_source_sha str No description.
branch str No description.
commit_author str No description.
commit_email str No description.
commit_message str No description.
content str No description.
file str No description.
id str No description.
overwrite_on_create typing.Union[bool, cdktf.IResolvable] No description.
repository str 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]]
commit_shaRequired 
commit_sha: str
  • Type: str
refRequired 
ref: str
  • Type: str
shaRequired 
sha: str
  • Type: str
autocreate_branch_inputOptional 
autocreate_branch_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
autocreate_branch_source_branch_inputOptional 
autocreate_branch_source_branch_input: str
  • Type: str
autocreate_branch_source_sha_inputOptional 
autocreate_branch_source_sha_input: str
  • Type: str
branch_inputOptional 
branch_input: str
  • Type: str
commit_author_inputOptional 
commit_author_input: str
  • Type: str
commit_email_inputOptional 
commit_email_input: str
  • Type: str
commit_message_inputOptional 
commit_message_input: str
  • Type: str
content_inputOptional 
content_input: str
  • Type: str
file_inputOptional 
file_input: str
  • Type: str
id_inputOptional 
id_input: str
  • Type: str
overwrite_on_create_inputOptional 
overwrite_on_create_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
repository_inputOptional 
repository_input: str
  • Type: str
autocreate_branchRequired 
autocreate_branch: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
autocreate_branch_source_branchRequired 
autocreate_branch_source_branch: str
  • Type: str
autocreate_branch_source_shaRequired 
autocreate_branch_source_sha: str
  • Type: str
branchRequired 
branch: str
  • Type: str
commit_authorRequired 
commit_author: str
  • Type: str
commit_emailRequired 
commit_email: str
  • Type: str
commit_messageRequired 
commit_message: str
  • Type: str
contentRequired 
content: str
  • Type: str
fileRequired 
file: str
  • Type: str
idRequired 
id: str
  • Type: str
overwrite_on_createRequired 
overwrite_on_create: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
repositoryRequired 
repository: str
  • Type: str

Constants

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

Structs

RepositoryFileConfig

Initializer 

from cdktf_cdktf_provider_github import repository_file

repositoryFile.RepositoryFileConfig(
  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,
  content: str,
  file: str,
  repository: str,
  autocreate_branch: typing.Union[bool, IResolvable] = None,
  autocreate_branch_source_branch: str = None,
  autocreate_branch_source_sha: str = None,
  branch: str = None,
  commit_author: str = None,
  commit_email: str = None,
  commit_message: str = None,
  id: str = None,
  overwrite_on_create: typing.Union[bool, IResolvable] = 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.
content str The file's content.
file str The file path to manage.
repository str The repository name.
autocreate_branch typing.Union[bool, cdktf.IResolvable] Automatically create the branch if it could not be found.
autocreate_branch_source_branch str The branch name to start from, if 'autocreate_branch' is set. Defaults to 'main'.
autocreate_branch_source_sha str The commit hash to start from, if 'autocreate_branch' is set.
branch str The branch name, defaults to the repository's default branch.
commit_author str The commit author name, defaults to the authenticated user's name.
commit_email str The commit author email address, defaults to the authenticated user's email address.
commit_message str The commit message when creating, updating or deleting the file.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#id RepositoryFile#id}.
overwrite_on_create typing.Union[bool, cdktf.IResolvable] Enable overwriting existing files, defaults to "false".
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]]
contentRequired 
content: str
  • Type: str

The file's content.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#content RepositoryFile#content}

fileRequired 
file: str
  • Type: str

The file path to manage.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#file RepositoryFile#file}

repositoryRequired 
repository: str
  • Type: str

The repository name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#repository RepositoryFile#repository}

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

Automatically create the branch if it could not be found.

Subsequent reads if the branch is deleted will occur from 'autocreate_branch_source_branch'

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#autocreate_branch RepositoryFile#autocreate_branch}

autocreate_branch_source_branchOptional 
autocreate_branch_source_branch: str
  • Type: str

The branch name to start from, if 'autocreate_branch' is set. Defaults to 'main'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#autocreate_branch_source_branch RepositoryFile#autocreate_branch_source_branch}

autocreate_branch_source_shaOptional 
autocreate_branch_source_sha: str
  • Type: str

The commit hash to start from, if 'autocreate_branch' is set.

Defaults to the tip of 'autocreate_branch_source_branch'. If provided, 'autocreate_branch_source_branch' is ignored.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#autocreate_branch_source_sha RepositoryFile#autocreate_branch_source_sha}

branchOptional 
branch: str
  • Type: str

The branch name, defaults to the repository's default branch.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#branch RepositoryFile#branch}

commit_authorOptional 
commit_author: str
  • Type: str

The commit author name, defaults to the authenticated user's name.

GitHub app users may omit author and email information so GitHub can verify commits as the GitHub App.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#commit_author RepositoryFile#commit_author}

commit_emailOptional 
commit_email: str
  • Type: str

The commit author email address, defaults to the authenticated user's email address.

GitHub app users may omit author and email information so GitHub can verify commits as the GitHub App.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#commit_email RepositoryFile#commit_email}

commit_messageOptional 
commit_message: str
  • Type: str

The commit message when creating, updating or deleting the file.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#commit_message RepositoryFile#commit_message}

idOptional 
id: str
  • Type: str

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

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

Enable overwriting existing files, defaults to "false".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/repository_file#overwrite_on_create RepositoryFile#overwrite_on_create}