datagithubcollaborators

README

data_github_collaborators

Refer to the Terraform Registory for docs: data_github_collaborators.

Documentation

Index

• func DataGithubCollaborators_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
• func DataGithubCollaborators_IsConstruct(x interface{}) *bool
• func DataGithubCollaborators_IsTerraformDataSource(x interface{}) *bool
• func DataGithubCollaborators_IsTerraformElement(x interface{}) *bool
• func DataGithubCollaborators_TfResourceType() *string
• func NewDataGithubCollaboratorsCollaboratorList_Override(d DataGithubCollaboratorsCollaboratorList, ...)
• func NewDataGithubCollaboratorsCollaboratorOutputReference_Override(d DataGithubCollaboratorsCollaboratorOutputReference, ...)
• func NewDataGithubCollaborators_Override(d DataGithubCollaborators, scope constructs.Construct, id *string, ...)
• type DataGithubCollaborators
  • func NewDataGithubCollaborators(scope constructs.Construct, id *string, config *DataGithubCollaboratorsConfig) DataGithubCollaborators
• type DataGithubCollaboratorsCollaborator
• type DataGithubCollaboratorsCollaboratorList
  • func NewDataGithubCollaboratorsCollaboratorList(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, ...) DataGithubCollaboratorsCollaboratorList
• type DataGithubCollaboratorsCollaboratorOutputReference
  • func NewDataGithubCollaboratorsCollaboratorOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, ...) DataGithubCollaboratorsCollaboratorOutputReference
• type DataGithubCollaboratorsConfig

Functions

func DataGithubCollaborators_GenerateConfigForImport

func DataGithubCollaborators_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource

Generates CDKTF code for importing a DataGithubCollaborators resource upon running "cdktf plan <stack-name>".

func DataGithubCollaborators_IsConstruct

func DataGithubCollaborators_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 DataGithubCollaborators_IsTerraformDataSource

func DataGithubCollaborators_IsTerraformDataSource(x interface{}) *bool

Experimental.

func DataGithubCollaborators_IsTerraformElement

func DataGithubCollaborators_IsTerraformElement(x interface{}) *bool

Experimental.

func DataGithubCollaborators_TfResourceType

func DataGithubCollaborators_TfResourceType() *string

func NewDataGithubCollaboratorsCollaboratorList_Override

func NewDataGithubCollaboratorsCollaboratorList_Override(d DataGithubCollaboratorsCollaboratorList, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool)

func NewDataGithubCollaboratorsCollaboratorOutputReference_Override

func NewDataGithubCollaboratorsCollaboratorOutputReference_Override(d DataGithubCollaboratorsCollaboratorOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool)

func NewDataGithubCollaborators_Override

func NewDataGithubCollaborators_Override(d DataGithubCollaborators, scope constructs.Construct, id *string, config *DataGithubCollaboratorsConfig)

Create a new {@link https://registry.terraform.io/providers/integrations/github/5.43.0/docs/data-sources/collaborators github_collaborators} Data Source.

Types

type DataGithubCollaborators

type DataGithubCollaborators interface {
	cdktf.TerraformDataSource
	Affiliation() *string
	SetAffiliation(val *string)
	AffiliationInput() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	Collaborator() DataGithubCollaboratorsCollaboratorList
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	// 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
	Owner() *string
	SetOwner(val *string)
	OwnerInput() *string
	// 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)
	ResetAffiliation()
	ResetId()
	// 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://registry.terraform.io/providers/integrations/github/5.43.0/docs/data-sources/collaborators github_collaborators}.

func NewDataGithubCollaborators

func NewDataGithubCollaborators(scope constructs.Construct, id *string, config *DataGithubCollaboratorsConfig) DataGithubCollaborators

Create a new {@link https://registry.terraform.io/providers/integrations/github/5.43.0/docs/data-sources/collaborators github_collaborators} Data Source.

type DataGithubCollaboratorsCollaborator

type DataGithubCollaboratorsCollaborator struct {
}

type DataGithubCollaboratorsCollaboratorList

type DataGithubCollaboratorsCollaboratorList 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) DataGithubCollaboratorsCollaboratorOutputReference
	// 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 NewDataGithubCollaboratorsCollaboratorList

func NewDataGithubCollaboratorsCollaboratorList(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) DataGithubCollaboratorsCollaboratorList

type DataGithubCollaboratorsCollaboratorOutputReference

type DataGithubCollaboratorsCollaboratorOutputReference 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
	EventsUrl() *string
	FollowersUrl() *string
	FollowingUrl() *string
	// Experimental.
	Fqn() *string
	GistsUrl() *string
	HtmlUrl() *string
	Id() *float64
	InternalValue() *DataGithubCollaboratorsCollaborator
	SetInternalValue(val *DataGithubCollaboratorsCollaborator)
	Login() *string
	OrganizationsUrl() *string
	Permission() *string
	ReceivedEventsUrl() *string
	ReposUrl() *string
	SiteAdmin() cdktf.IResolvable
	StarredUrl() *string
	SubscriptionsUrl() *string
	// Experimental.
	TerraformAttribute() *string
	// Experimental.
	SetTerraformAttribute(val *string)
	// Experimental.
	TerraformResource() cdktf.IInterpolatingParent
	// Experimental.
	SetTerraformResource(val cdktf.IInterpolatingParent)
	Type() *string
	Url() *string
	// 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 NewDataGithubCollaboratorsCollaboratorOutputReference

func NewDataGithubCollaboratorsCollaboratorOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool) DataGithubCollaboratorsCollaboratorOutputReference

type DataGithubCollaboratorsConfig

type DataGithubCollaboratorsConfig 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.43.0/docs/data-sources/collaborators#owner DataGithubCollaborators#owner}.
	Owner *string `field:"required" json:"owner" yaml:"owner"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.43.0/docs/data-sources/collaborators#repository DataGithubCollaborators#repository}.
	Repository *string `field:"required" json:"repository" yaml:"repository"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.43.0/docs/data-sources/collaborators#affiliation DataGithubCollaborators#affiliation}.
	Affiliation *string `field:"optional" json:"affiliation" yaml:"affiliation"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/5.43.0/docs/data-sources/collaborators#id DataGithubCollaborators#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"`
}