Documentation
¶
Index ¶
- func DataGithubRepositoryBranches_IsConstruct(x interface{}) *bool
- func DataGithubRepositoryBranches_IsTerraformDataSource(x interface{}) *bool
- func DataGithubRepositoryBranches_IsTerraformElement(x interface{}) *bool
- func DataGithubRepositoryBranches_TfResourceType() *string
- func NewDataGithubRepositoryBranchesBranchesList_Override(d DataGithubRepositoryBranchesBranchesList, ...)
- func NewDataGithubRepositoryBranchesBranchesOutputReference_Override(d DataGithubRepositoryBranchesBranchesOutputReference, ...)
- func NewDataGithubRepositoryBranches_Override(d DataGithubRepositoryBranches, scope constructs.Construct, id *string, ...)
- type DataGithubRepositoryBranches
- type DataGithubRepositoryBranchesBranches
- type DataGithubRepositoryBranchesBranchesList
- type DataGithubRepositoryBranchesBranchesOutputReference
- type DataGithubRepositoryBranchesConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DataGithubRepositoryBranches_IsConstruct ¶
func DataGithubRepositoryBranches_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 DataGithubRepositoryBranches_IsTerraformDataSource ¶
func DataGithubRepositoryBranches_IsTerraformDataSource(x interface{}) *bool
Experimental.
func DataGithubRepositoryBranches_IsTerraformElement ¶
func DataGithubRepositoryBranches_IsTerraformElement(x interface{}) *bool
Experimental.
func DataGithubRepositoryBranches_TfResourceType ¶
func DataGithubRepositoryBranches_TfResourceType() *string
func NewDataGithubRepositoryBranchesBranchesList_Override ¶
func NewDataGithubRepositoryBranchesBranchesList_Override(d DataGithubRepositoryBranchesBranchesList, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool)
func NewDataGithubRepositoryBranchesBranchesOutputReference_Override ¶
func NewDataGithubRepositoryBranchesBranchesOutputReference_Override(d DataGithubRepositoryBranchesBranchesOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool)
func NewDataGithubRepositoryBranches_Override ¶
func NewDataGithubRepositoryBranches_Override(d DataGithubRepositoryBranches, scope constructs.Construct, id *string, config *DataGithubRepositoryBranchesConfig)
Create a new {@link https://www.terraform.io/docs/providers/github/d/repository_branches github_repository_branches} Data Source.
Types ¶
type DataGithubRepositoryBranches ¶
type DataGithubRepositoryBranches interface {
cdktf.TerraformDataSource
Branches() DataGithubRepositoryBranchesBranchesList
// Experimental.
CdktfStack() cdktf.TerraformStack
// Experimental.
ConstructNodeMetadata() *map[string]interface{}
// Experimental.
Count() *float64
// Experimental.
SetCount(val *float64)
// Experimental.
DependsOn() *[]*string
// Experimental.
SetDependsOn(val *[]*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
OnlyNonProtectedBranches() interface{}
SetOnlyNonProtectedBranches(val interface{})
OnlyNonProtectedBranchesInput() interface{}
OnlyProtectedBranches() interface{}
SetOnlyProtectedBranches(val interface{})
OnlyProtectedBranchesInput() interface{}
// Experimental.
Provider() cdktf.TerraformProvider
// Experimental.
SetProvider(val cdktf.TerraformProvider)
// Experimental.
RawOverrides() interface{}
Repository() *string
SetRepository(val *string)
RepositoryInput() *string
// Experimental.
TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
// Experimental.
TerraformMetaArguments() *map[string]interface{}
// Experimental.
TerraformResourceType() *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.
InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
ResetId()
ResetOnlyNonProtectedBranches()
ResetOnlyProtectedBranches()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
SynthesizeAttributes() *map[string]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://www.terraform.io/docs/providers/github/d/repository_branches github_repository_branches}.
func NewDataGithubRepositoryBranches ¶
func NewDataGithubRepositoryBranches(scope constructs.Construct, id *string, config *DataGithubRepositoryBranchesConfig) DataGithubRepositoryBranches
Create a new {@link https://www.terraform.io/docs/providers/github/d/repository_branches github_repository_branches} Data Source.
type DataGithubRepositoryBranchesBranches ¶
type DataGithubRepositoryBranchesBranches struct {
}
type DataGithubRepositoryBranchesBranchesList ¶
type DataGithubRepositoryBranchesBranchesList interface {
cdktf.ComplexList
// 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.
// Experimental.
CreationStack() *[]*string
// Experimental.
Fqn() *string
// The attribute on the parent resource this class is referencing.
TerraformAttribute() *string
SetTerraformAttribute(val *string)
// The parent resource.
TerraformResource() cdktf.IInterpolatingParent
SetTerraformResource(val cdktf.IInterpolatingParent)
// whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
WrapsSet() *bool
SetWrapsSet(val *bool)
// Experimental.
ComputeFqn() *string
Get(index *float64) DataGithubRepositoryBranchesBranchesOutputReference
// Produce the Token's value at resolution time.
// Experimental.
Resolve(_context cdktf.IResolveContext) interface{}
// Return a string representation of this resolvable object.
//
// Returns a reversible string representation.
// Experimental.
ToString() *string
}
func NewDataGithubRepositoryBranchesBranchesList ¶
func NewDataGithubRepositoryBranchesBranchesList(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) DataGithubRepositoryBranchesBranchesList
type DataGithubRepositoryBranchesBranchesOutputReference ¶
type DataGithubRepositoryBranchesBranchesOutputReference interface {
cdktf.ComplexObject
// the index of the complex object in a list.
// Experimental.
ComplexObjectIndex() interface{}
// Experimental.
SetComplexObjectIndex(val interface{})
// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
// Experimental.
ComplexObjectIsFromSet() *bool
// Experimental.
SetComplexObjectIsFromSet(val *bool)
// 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.
// Experimental.
CreationStack() *[]*string
// Experimental.
Fqn() *string
InternalValue() *DataGithubRepositoryBranchesBranches
SetInternalValue(val *DataGithubRepositoryBranchesBranches)
Name() *string
Protected() cdktf.IResolvable
// Experimental.
TerraformAttribute() *string
// Experimental.
SetTerraformAttribute(val *string)
// Experimental.
TerraformResource() cdktf.IInterpolatingParent
// Experimental.
SetTerraformResource(val cdktf.IInterpolatingParent)
// Experimental.
ComputeFqn() *string
// 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.
InterpolationAsList() cdktf.IResolvable
// Experimental.
InterpolationForAttribute(property *string) cdktf.IResolvable
// Produce the Token's value at resolution time.
// Experimental.
Resolve(_context cdktf.IResolveContext) interface{}
// Return a string representation of this resolvable object.
//
// Returns a reversible string representation.
// Experimental.
ToString() *string
}
func NewDataGithubRepositoryBranchesBranchesOutputReference ¶
func NewDataGithubRepositoryBranchesBranchesOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool) DataGithubRepositoryBranchesBranchesOutputReference
type DataGithubRepositoryBranchesConfig ¶
type DataGithubRepositoryBranchesConfig struct {
// Experimental.
Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
// Experimental.
Count *float64 `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"`
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/d/repository_branches#repository DataGithubRepositoryBranches#repository}.
Repository *string `field:"required" json:"repository" yaml:"repository"`
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/d/repository_branches#id DataGithubRepositoryBranches#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"`
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/d/repository_branches#only_non_protected_branches DataGithubRepositoryBranches#only_non_protected_branches}.
OnlyNonProtectedBranches interface{} `field:"optional" json:"onlyNonProtectedBranches" yaml:"onlyNonProtectedBranches"`
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/d/repository_branches#only_protected_branches DataGithubRepositoryBranches#only_protected_branches}.
OnlyProtectedBranches interface{} `field:"optional" json:"onlyProtectedBranches" yaml:"onlyProtectedBranches"`
}
Source Files
¶
- DataGithubRepositoryBranches.go
- DataGithubRepositoryBranchesBranches.go
- DataGithubRepositoryBranchesBranchesList.go
- DataGithubRepositoryBranchesBranchesList__checks.go
- DataGithubRepositoryBranchesBranchesOutputReference.go
- DataGithubRepositoryBranchesBranchesOutputReference__checks.go
- DataGithubRepositoryBranchesConfig.go
- DataGithubRepositoryBranches__checks.go
- main.go