Skip to content

repositoryFile.typescript.md

Latest commit

 

History

History
1342 lines (832 loc) · 54.1 KB

repositoryFile.typescript.md

File metadata and controls

1342 lines (832 loc) · 54.1 KB
Raw

repositoryFile Submodule

Constructs

RepositoryFile

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

Initializers 

import { repositoryFile } from '@cdktn/provider-github'

new repositoryFile.RepositoryFile(scope: Construct, id: string, config: RepositoryFileConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config RepositoryFileConfig No description.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

Methods

Name Description
toString Returns a string representation of this construct.
with Applies one or more mixins to this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
resetAutocreateBranch No description.
resetAutocreateBranchSourceBranch No description.
resetAutocreateBranchSourceSha No description.
resetBranch No description.
resetCommitAuthor No description.
resetCommitEmail No description.
resetCommitMessage No description.
resetId No description.
resetOverwriteOnCreate No description.
toString 
public toString(): string

Returns a string representation of this construct.

with 
public 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.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

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

toHclTerraform 
public toHclTerraform(): any
toMetadata 
public toMetadata(): any
toTerraform 
public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget 
public addMoveTarget(moveTarget: string): void

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

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
hasResourceMove 
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom 
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string
providerOptional
  • Type: cdktn.TerraformProvider
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
moveFromId 
public moveFromId(id: string): void

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: string

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

moveTo 
public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

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

indexOptional
  • Type: string | number

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

moveToId 
public moveToId(id: string): void

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

idRequired
  • Type: string

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

resetAutocreateBranch 
public resetAutocreateBranch(): void
resetAutocreateBranchSourceBranch 
public resetAutocreateBranchSourceBranch(): void
resetAutocreateBranchSourceSha 
public resetAutocreateBranchSourceSha(): void
resetBranch 
public resetBranch(): void
resetCommitAuthor 
public resetCommitAuthor(): void
resetCommitEmail 
public resetCommitEmail(): void
resetCommitMessage 
public resetCommitMessage(): void
resetId 
public resetId(): void
resetOverwriteOnCreate 
public resetOverwriteOnCreate(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTN code for importing a RepositoryFile resource upon running "cdktn plan ".
isConstruct 
import { repositoryFile } from '@cdktn/provider-github'

repositoryFile.RepositoryFile.isConstruct(x: 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: any

Any object.

isTerraformElement 
import { repositoryFile } from '@cdktn/provider-github'

repositoryFile.RepositoryFile.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { repositoryFile } from '@cdktn/provider-github'

repositoryFile.RepositoryFile.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { repositoryFile } from '@cdktn/provider-github'

repositoryFile.RepositoryFile.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTN code for importing a RepositoryFile resource upon running "cdktn plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: string

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

importFromIdRequired
  • Type: string

The id of the existing RepositoryFile that should be imported.

Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.13.0/docs/resources/repository_file#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 RepositoryFile to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktn.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktn.TerraformProviderGeneratorMetadata No description.
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count number | cdktn.TerraformCount No description.
dependsOn string[] No description.
forEach cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[] No description.
commitSha string No description.
ref string No description.
repositoryId number No description.
sha string No description.
autocreateBranchInput boolean | cdktn.IResolvable No description.
autocreateBranchSourceBranchInput string No description.
autocreateBranchSourceShaInput string No description.
branchInput string No description.
commitAuthorInput string No description.
commitEmailInput string No description.
commitMessageInput string No description.
contentInput string No description.
fileInput string No description.
idInput string No description.
overwriteOnCreateInput boolean | cdktn.IResolvable No description.
repositoryInput string No description.
autocreateBranch boolean | cdktn.IResolvable No description.
autocreateBranchSourceBranch string No description.
autocreateBranchSourceSha string No description.
branch string No description.
commitAuthor string No description.
commitEmail string No description.
commitMessage string No description.
content string No description.
file string No description.
id string No description.
overwriteOnCreate boolean | cdktn.IResolvable No description.
repository string No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktn.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktn.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktn.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktn.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktn.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktn.TerraformProvider
provisionersOptional 
public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];
  • Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]
commitShaRequired 
public readonly commitSha: string;
  • Type: string
refRequired 
public readonly ref: string;
  • Type: string
repositoryIdRequired 
public readonly repositoryId: number;
  • Type: number
shaRequired 
public readonly sha: string;
  • Type: string
autocreateBranchInputOptional 
public readonly autocreateBranchInput: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable
autocreateBranchSourceBranchInputOptional 
public readonly autocreateBranchSourceBranchInput: string;
  • Type: string
autocreateBranchSourceShaInputOptional 
public readonly autocreateBranchSourceShaInput: string;
  • Type: string
branchInputOptional 
public readonly branchInput: string;
  • Type: string
commitAuthorInputOptional 
public readonly commitAuthorInput: string;
  • Type: string
commitEmailInputOptional 
public readonly commitEmailInput: string;
  • Type: string
commitMessageInputOptional 
public readonly commitMessageInput: string;
  • Type: string
contentInputOptional 
public readonly contentInput: string;
  • Type: string
fileInputOptional 
public readonly fileInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
overwriteOnCreateInputOptional 
public readonly overwriteOnCreateInput: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable
repositoryInputOptional 
public readonly repositoryInput: string;
  • Type: string
autocreateBranchRequired 
public readonly autocreateBranch: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable
autocreateBranchSourceBranchRequired 
public readonly autocreateBranchSourceBranch: string;
  • Type: string
autocreateBranchSourceShaRequired 
public readonly autocreateBranchSourceSha: string;
  • Type: string
branchRequired 
public readonly branch: string;
  • Type: string
commitAuthorRequired 
public readonly commitAuthor: string;
  • Type: string
commitEmailRequired 
public readonly commitEmail: string;
  • Type: string
commitMessageRequired 
public readonly commitMessage: string;
  • Type: string
contentRequired 
public readonly content: string;
  • Type: string
fileRequired 
public readonly file: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
overwriteOnCreateRequired 
public readonly overwriteOnCreate: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable
repositoryRequired 
public readonly repository: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

RepositoryFileConfig

Initializer 

import { repositoryFile } from '@cdktn/provider-github'

const repositoryFileConfig: repositoryFile.RepositoryFileConfig = { ... }

Properties

Name Type Description
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count number | cdktn.TerraformCount No description.
dependsOn cdktn.ITerraformDependable[] No description.
forEach cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[] No description.
content string The file's content.
file string The file path to manage.
repository string The repository name.
autocreateBranch boolean | cdktn.IResolvable Automatically create the branch if it could not be found.
autocreateBranchSourceBranch string The branch name to start from, if 'autocreate_branch' is set. Defaults to 'main'.
autocreateBranchSourceSha string The commit hash to start from, if 'autocreate_branch' is set.
branch string The branch name, defaults to the repository's default branch.
commitAuthor string The commit author name, defaults to the authenticated user's name.
commitEmail string The commit author email address, defaults to the authenticated user's email address.
commitMessage string The commit message when creating, updating or deleting the file.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.13.0/docs/resources/repository_file#id RepositoryFile#id}.
overwriteOnCreate boolean | cdktn.IResolvable Enable overwriting existing files, defaults to "false".
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktn.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktn.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktn.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktn.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktn.TerraformProvider
provisionersOptional 
public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];
  • Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]
contentRequired 
public readonly content: string;
  • Type: string

The file's content.

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

fileRequired 
public readonly file: string;
  • Type: string

The file path to manage.

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

repositoryRequired 
public readonly repository: string;
  • Type: string

The repository name.

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

autocreateBranchOptional 
public readonly autocreateBranch: boolean | IResolvable;
  • Type: boolean | cdktn.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.13.0/docs/resources/repository_file#autocreate_branch RepositoryFile#autocreate_branch}

autocreateBranchSourceBranchOptional 
public readonly autocreateBranchSourceBranch: string;
  • Type: string

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.13.0/docs/resources/repository_file#autocreate_branch_source_branch RepositoryFile#autocreate_branch_source_branch}

autocreateBranchSourceShaOptional 
public readonly autocreateBranchSourceSha: string;
  • Type: string

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.13.0/docs/resources/repository_file#autocreate_branch_source_sha RepositoryFile#autocreate_branch_source_sha}

branchOptional 
public readonly branch: string;
  • Type: string

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

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

commitAuthorOptional 
public readonly commitAuthor: string;
  • Type: string

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.13.0/docs/resources/repository_file#commit_author RepositoryFile#commit_author}

commitEmailOptional 
public readonly commitEmail: string;
  • Type: string

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.13.0/docs/resources/repository_file#commit_email RepositoryFile#commit_email}

commitMessageOptional 
public readonly commitMessage: string;
  • Type: string

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

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

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.13.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.

overwriteOnCreateOptional 
public readonly overwriteOnCreate: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

Enable overwriting existing files, defaults to "false".

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