Documentation
¶
Index ¶
- func NewRepositoryFile_Override(r RepositoryFile, scope constructs.Construct, id *string, ...)
- func RepositoryFile_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func RepositoryFile_IsConstruct(x interface{}) *bool
- func RepositoryFile_IsTerraformElement(x interface{}) *bool
- func RepositoryFile_IsTerraformResource(x interface{}) *bool
- func RepositoryFile_TfResourceType() *string
- type RepositoryFile
- type RepositoryFileConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewRepositoryFile_Override ¶
func NewRepositoryFile_Override(r RepositoryFile, scope constructs.Construct, id *string, config *RepositoryFileConfig)
Create a new {@link https://registry.terraform.io/providers/integrations/github/6.3.0/docs/resources/repository_file github_repository_file} Resource.
func RepositoryFile_GenerateConfigForImport ¶
func RepositoryFile_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a RepositoryFile resource upon running "cdktf plan <stack-name>".
func RepositoryFile_IsConstruct ¶
func RepositoryFile_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func RepositoryFile_IsTerraformElement ¶
func RepositoryFile_IsTerraformElement(x interface{}) *bool
Experimental.
func RepositoryFile_IsTerraformResource ¶
func RepositoryFile_IsTerraformResource(x interface{}) *bool
Experimental.
func RepositoryFile_TfResourceType ¶
func RepositoryFile_TfResourceType() *string
Types ¶
type RepositoryFile ¶
type RepositoryFile interface {
cdktf.TerraformResource
AutocreateBranch() interface{}
SetAutocreateBranch(val interface{})
AutocreateBranchInput() interface{}
AutocreateBranchSourceBranch() *string
SetAutocreateBranchSourceBranch(val *string)
AutocreateBranchSourceBranchInput() *string
AutocreateBranchSourceSha() *string
SetAutocreateBranchSourceSha(val *string)
AutocreateBranchSourceShaInput() *string
Branch() *string
SetBranch(val *string)
BranchInput() *string
// Experimental.
CdktfStack() cdktf.TerraformStack
CommitAuthor() *string
SetCommitAuthor(val *string)
CommitAuthorInput() *string
CommitEmail() *string
SetCommitEmail(val *string)
CommitEmailInput() *string
CommitMessage() *string
SetCommitMessage(val *string)
CommitMessageInput() *string
CommitSha() *string
// Experimental.
Connection() interface{}
// Experimental.
SetConnection(val interface{})
// Experimental.
ConstructNodeMetadata() *map[string]interface{}
Content() *string
SetContent(val *string)
ContentInput() *string
// Experimental.
Count() interface{}
// Experimental.
SetCount(val interface{})
// Experimental.
DependsOn() *[]*string
// Experimental.
SetDependsOn(val *[]*string)
File() *string
SetFile(val *string)
FileInput() *string
// Experimental.
ForEach() cdktf.ITerraformIterator
// Experimental.
SetForEach(val cdktf.ITerraformIterator)
// Experimental.
Fqn() *string
// Experimental.
FriendlyUniqueId() *string
Id() *string
SetId(val *string)
IdInput() *string
// Experimental.
Lifecycle() *cdktf.TerraformResourceLifecycle
// Experimental.
SetLifecycle(val *cdktf.TerraformResourceLifecycle)
// The tree node.
Node() constructs.Node
OverwriteOnCreate() interface{}
SetOverwriteOnCreate(val interface{})
OverwriteOnCreateInput() interface{}
// Experimental.
Provider() cdktf.TerraformProvider
// Experimental.
SetProvider(val cdktf.TerraformProvider)
// Experimental.
Provisioners() *[]interface{}
// Experimental.
SetProvisioners(val *[]interface{})
// Experimental.
RawOverrides() interface{}
Ref() *string
Repository() *string
SetRepository(val *string)
RepositoryInput() *string
Sha() *string
// Experimental.
TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
// Experimental.
TerraformMetaArguments() *map[string]interface{}
// Experimental.
TerraformResourceType() *string
// Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
// Experimental.
AddMoveTarget(moveTarget *string)
// Experimental.
AddOverride(path *string, value interface{})
// Experimental.
GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
// Experimental.
GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
// Experimental.
GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
// Experimental.
GetListAttribute(terraformAttribute *string) *[]*string
// Experimental.
GetNumberAttribute(terraformAttribute *string) *float64
// Experimental.
GetNumberListAttribute(terraformAttribute *string) *[]*float64
// Experimental.
GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
// Experimental.
GetStringAttribute(terraformAttribute *string) *string
// Experimental.
GetStringMapAttribute(terraformAttribute *string) *map[string]*string
// Experimental.
HasResourceMove() interface{}
// Experimental.
ImportFrom(id *string, provider cdktf.TerraformProvider)
// Experimental.
InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
// 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.
// Experimental.
MoveFromId(id *string)
// Moves this resource to the target resource given by moveTarget.
// Experimental.
MoveTo(moveTarget *string, index interface{})
// Moves this resource to the resource corresponding to "id".
// Experimental.
MoveToId(id *string)
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
ResetAutocreateBranch()
ResetAutocreateBranchSourceBranch()
ResetAutocreateBranchSourceSha()
ResetBranch()
ResetCommitAuthor()
ResetCommitEmail()
ResetCommitMessage()
ResetId()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
ResetOverwriteOnCreate()
SynthesizeAttributes() *map[string]interface{}
SynthesizeHclAttributes() *map[string]interface{}
// Experimental.
ToHclTerraform() interface{}
// Experimental.
ToMetadata() interface{}
// Returns a string representation of this construct.
ToString() *string
// Adds this resource to the terraform JSON output.
// Experimental.
ToTerraform() interface{}
}
Represents a {@link https://registry.terraform.io/providers/integrations/github/6.3.0/docs/resources/repository_file github_repository_file}.
func NewRepositoryFile ¶
func NewRepositoryFile(scope constructs.Construct, id *string, config *RepositoryFileConfig) RepositoryFile
Create a new {@link https://registry.terraform.io/providers/integrations/github/6.3.0/docs/resources/repository_file github_repository_file} Resource.
type RepositoryFileConfig ¶
type RepositoryFileConfig struct {
// Experimental.
Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
// Experimental.
Count interface{} `field:"optional" json:"count" yaml:"count"`
// Experimental.
DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
// Experimental.
ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
// Experimental.
Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
// Experimental.
Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
// Experimental.
Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
// The file's content.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.0/docs/resources/repository_file#content RepositoryFile#content}
Content *string `field:"required" json:"content" yaml:"content"`
// The file path to manage.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.0/docs/resources/repository_file#file RepositoryFile#file}
File *string `field:"required" json:"file" yaml:"file"`
// The repository name.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.0/docs/resources/repository_file#repository RepositoryFile#repository}
Repository *string `field:"required" json:"repository" yaml:"repository"`
// 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.3.0/docs/resources/repository_file#autocreate_branch RepositoryFile#autocreate_branch}
AutocreateBranch interface{} `field:"optional" json:"autocreateBranch" yaml:"autocreateBranch"`
// 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.3.0/docs/resources/repository_file#autocreate_branch_source_branch RepositoryFile#autocreate_branch_source_branch}
AutocreateBranchSourceBranch *string `field:"optional" json:"autocreateBranchSourceBranch" yaml:"autocreateBranchSourceBranch"`
// 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.3.0/docs/resources/repository_file#autocreate_branch_source_sha RepositoryFile#autocreate_branch_source_sha}
AutocreateBranchSourceSha *string `field:"optional" json:"autocreateBranchSourceSha" yaml:"autocreateBranchSourceSha"`
// The branch name, defaults to the repository's default branch.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.0/docs/resources/repository_file#branch RepositoryFile#branch}
Branch *string `field:"optional" json:"branch" yaml:"branch"`
// 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.3.0/docs/resources/repository_file#commit_author RepositoryFile#commit_author}
CommitAuthor *string `field:"optional" json:"commitAuthor" yaml:"commitAuthor"`
// 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.3.0/docs/resources/repository_file#commit_email RepositoryFile#commit_email}
CommitEmail *string `field:"optional" json:"commitEmail" yaml:"commitEmail"`
// The commit message when creating, updating or deleting the file.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.0/docs/resources/repository_file#commit_message RepositoryFile#commit_message}
CommitMessage *string `field:"optional" json:"commitMessage" yaml:"commitMessage"`
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.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.
Id *string `field:"optional" json:"id" yaml:"id"`
// Enable overwriting existing files, defaults to "false".
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.3.0/docs/resources/repository_file#overwrite_on_create RepositoryFile#overwrite_on_create}
OverwriteOnCreate interface{} `field:"optional" json:"overwriteOnCreate" yaml:"overwriteOnCreate"`
}