Documentation
¶
Index ¶
- func DataGithubTeam_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func DataGithubTeam_IsConstruct(x interface{}) *bool
- func DataGithubTeam_IsTerraformDataSource(x interface{}) *bool
- func DataGithubTeam_IsTerraformElement(x interface{}) *bool
- func DataGithubTeam_TfResourceType() *string
- func NewDataGithubTeamRepositoriesDetailedList_Override(d DataGithubTeamRepositoriesDetailedList, ...)
- func NewDataGithubTeamRepositoriesDetailedOutputReference_Override(d DataGithubTeamRepositoriesDetailedOutputReference, ...)
- func NewDataGithubTeam_Override(d DataGithubTeam, scope constructs.Construct, id *string, ...)
- type DataGithubTeam
- type DataGithubTeamConfig
- type DataGithubTeamRepositoriesDetailed
- type DataGithubTeamRepositoriesDetailedList
- type DataGithubTeamRepositoriesDetailedOutputReference
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DataGithubTeam_GenerateConfigForImport ¶
func DataGithubTeam_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a DataGithubTeam resource upon running "cdktf plan <stack-name>".
func DataGithubTeam_IsConstruct ¶
func DataGithubTeam_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 DataGithubTeam_IsTerraformDataSource ¶
func DataGithubTeam_IsTerraformDataSource(x interface{}) *bool
Experimental.
func DataGithubTeam_IsTerraformElement ¶
func DataGithubTeam_IsTerraformElement(x interface{}) *bool
Experimental.
func DataGithubTeam_TfResourceType ¶
func DataGithubTeam_TfResourceType() *string
func NewDataGithubTeamRepositoriesDetailedList_Override ¶
func NewDataGithubTeamRepositoriesDetailedList_Override(d DataGithubTeamRepositoriesDetailedList, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool)
func NewDataGithubTeamRepositoriesDetailedOutputReference_Override ¶
func NewDataGithubTeamRepositoriesDetailedOutputReference_Override(d DataGithubTeamRepositoriesDetailedOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool)
func NewDataGithubTeam_Override ¶
func NewDataGithubTeam_Override(d DataGithubTeam, scope constructs.Construct, id *string, config *DataGithubTeamConfig)
Create a new {@link https://registry.terraform.io/providers/integrations/github/5.42.0/docs/data-sources/team github_team} Data Source.
Types ¶
type DataGithubTeam ¶
type DataGithubTeam interface {
cdktf.TerraformDataSource
// Experimental.
CdktfStack() cdktf.TerraformStack
// Experimental.
ConstructNodeMetadata() *map[string]interface{}
// Experimental.
Count() interface{}
// Experimental.
SetCount(val interface{})
// Experimental.
DependsOn() *[]*string
// Experimental.
SetDependsOn(val *[]*string)
Description() *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)
Members() *[]*string
MembershipType() *string
SetMembershipType(val *string)
MembershipTypeInput() *string
Name() *string
// The tree node.
Node() constructs.Node
NodeId() *string
Permission() *string
Privacy() *string
// Experimental.
Provider() cdktf.TerraformProvider
// Experimental.
SetProvider(val cdktf.TerraformProvider)
// Experimental.
RawOverrides() interface{}
Repositories() *[]*string
RepositoriesDetailed() DataGithubTeamRepositoriesDetailedList
ResultsPerPage() *float64
SetResultsPerPage(val *float64)
ResultsPerPageInput() *float64
Slug() *string
SetSlug(val *string)
SlugInput() *string
SummaryOnly() interface{}
SetSummaryOnly(val interface{})
SummaryOnlyInput() interface{}
// 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()
ResetMembershipType()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
ResetResultsPerPage()
ResetSummaryOnly()
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://registry.terraform.io/providers/integrations/github/5.42.0/docs/data-sources/team github_team}.
func NewDataGithubTeam ¶
func NewDataGithubTeam(scope constructs.Construct, id *string, config *DataGithubTeamConfig) DataGithubTeam
Create a new {@link https://registry.terraform.io/providers/integrations/github/5.42.0/docs/data-sources/team github_team} Data Source.
type DataGithubTeamConfig ¶
type DataGithubTeamConfig 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"`
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.42.0/docs/data-sources/team#slug DataGithubTeam#slug}.
Slug *string `field:"required" json:"slug" yaml:"slug"`
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.42.0/docs/data-sources/team#id DataGithubTeam#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://registry.terraform.io/providers/integrations/github/5.42.0/docs/data-sources/team#membership_type DataGithubTeam#membership_type}.
MembershipType *string `field:"optional" json:"membershipType" yaml:"membershipType"`
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.42.0/docs/data-sources/team#results_per_page DataGithubTeam#results_per_page}.
ResultsPerPage *float64 `field:"optional" json:"resultsPerPage" yaml:"resultsPerPage"`
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.42.0/docs/data-sources/team#summary_only DataGithubTeam#summary_only}.
SummaryOnly interface{} `field:"optional" json:"summaryOnly" yaml:"summaryOnly"`
}
type DataGithubTeamRepositoriesDetailed ¶
type DataGithubTeamRepositoriesDetailed struct {
}
type DataGithubTeamRepositoriesDetailedList ¶
type DataGithubTeamRepositoriesDetailedList 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) DataGithubTeamRepositoriesDetailedOutputReference
// 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 NewDataGithubTeamRepositoriesDetailedList ¶
func NewDataGithubTeamRepositoriesDetailedList(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) DataGithubTeamRepositoriesDetailedList
type DataGithubTeamRepositoriesDetailedOutputReference ¶
type DataGithubTeamRepositoriesDetailedOutputReference 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() *DataGithubTeamRepositoriesDetailed
SetInternalValue(val *DataGithubTeamRepositoriesDetailed)
RepoId() *float64
RoleName() *string
// 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 NewDataGithubTeamRepositoriesDetailedOutputReference ¶
func NewDataGithubTeamRepositoriesDetailedOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool) DataGithubTeamRepositoriesDetailedOutputReference
Source Files
¶
- DataGithubTeam.go
- DataGithubTeamConfig.go
- DataGithubTeamRepositoriesDetailed.go
- DataGithubTeamRepositoriesDetailedList.go
- DataGithubTeamRepositoriesDetailedList__checks.go
- DataGithubTeamRepositoriesDetailedOutputReference.go
- DataGithubTeamRepositoriesDetailedOutputReference__checks.go
- DataGithubTeam__checks.go
- main.go