Documentation
¶
Index ¶
- func DataGitlabGroups_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func DataGitlabGroups_IsConstruct(x interface{}) *bool
- func DataGitlabGroups_IsTerraformDataSource(x interface{}) *bool
- func DataGitlabGroups_IsTerraformElement(x interface{}) *bool
- func DataGitlabGroups_TfResourceType() *string
- func NewDataGitlabGroupsGroupsList_Override(d DataGitlabGroupsGroupsList, terraformResource cdktf.IInterpolatingParent, ...)
- func NewDataGitlabGroupsGroupsOutputReference_Override(d DataGitlabGroupsGroupsOutputReference, ...)
- func NewDataGitlabGroups_Override(d DataGitlabGroups, scope constructs.Construct, id *string, ...)
- type DataGitlabGroups
- type DataGitlabGroupsConfig
- type DataGitlabGroupsGroups
- type DataGitlabGroupsGroupsList
- type DataGitlabGroupsGroupsOutputReference
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DataGitlabGroups_GenerateConfigForImport ¶
func DataGitlabGroups_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a DataGitlabGroups resource upon running "cdktf plan <stack-name>".
func DataGitlabGroups_IsConstruct ¶
func DataGitlabGroups_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 DataGitlabGroups_IsTerraformDataSource ¶
func DataGitlabGroups_IsTerraformDataSource(x interface{}) *bool
Experimental.
func DataGitlabGroups_IsTerraformElement ¶
func DataGitlabGroups_IsTerraformElement(x interface{}) *bool
Experimental.
func DataGitlabGroups_TfResourceType ¶
func DataGitlabGroups_TfResourceType() *string
func NewDataGitlabGroupsGroupsList_Override ¶
func NewDataGitlabGroupsGroupsList_Override(d DataGitlabGroupsGroupsList, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool)
func NewDataGitlabGroupsGroupsOutputReference_Override ¶
func NewDataGitlabGroupsGroupsOutputReference_Override(d DataGitlabGroupsGroupsOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool)
func NewDataGitlabGroups_Override ¶
func NewDataGitlabGroups_Override(d DataGitlabGroups, scope constructs.Construct, id *string, config *DataGitlabGroupsConfig)
Create a new {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.9.0/docs/data-sources/groups gitlab_groups} Data Source.
Types ¶
type DataGitlabGroups ¶
type DataGitlabGroups 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)
// Experimental.
ForEach() cdktf.ITerraformIterator
// Experimental.
SetForEach(val cdktf.ITerraformIterator)
// Experimental.
Fqn() *string
// Experimental.
FriendlyUniqueId() *string
Groups() DataGitlabGroupsGroupsList
Id() *string
SetId(val *string)
IdInput() *string
// Experimental.
Lifecycle() *cdktf.TerraformResourceLifecycle
// Experimental.
SetLifecycle(val *cdktf.TerraformResourceLifecycle)
// The tree node.
Node() constructs.Node
OrderBy() *string
SetOrderBy(val *string)
OrderByInput() *string
// Experimental.
Provider() cdktf.TerraformProvider
// Experimental.
SetProvider(val cdktf.TerraformProvider)
// Experimental.
RawOverrides() interface{}
Search() *string
SetSearch(val *string)
SearchInput() *string
Sort() *string
SetSort(val *string)
SortInput() *string
// Experimental.
TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
// Experimental.
TerraformMetaArguments() *map[string]interface{}
// Experimental.
TerraformResourceType() *string
TopLevelOnly() interface{}
SetTopLevelOnly(val interface{})
TopLevelOnlyInput() interface{}
// 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()
ResetOrderBy()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
ResetSearch()
ResetSort()
ResetTopLevelOnly()
SynthesizeAttributes() *map[string]interface{}
SynthesizeHclAttributes() *map[string]interface{}
// Adds this resource to the terraform JSON output.
// 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/gitlabhq/gitlab/17.9.0/docs/data-sources/groups gitlab_groups}.
func NewDataGitlabGroups ¶
func NewDataGitlabGroups(scope constructs.Construct, id *string, config *DataGitlabGroupsConfig) DataGitlabGroups
Create a new {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.9.0/docs/data-sources/groups gitlab_groups} Data Source.
type DataGitlabGroupsConfig ¶
type DataGitlabGroupsConfig 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/gitlabhq/gitlab/17.9.0/docs/data-sources/groups#id DataGitlabGroups#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"`
// Order the groups' list by `id`, `name`, `path`, or `similarity`. (Requires administrator privileges).
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.9.0/docs/data-sources/groups#order_by DataGitlabGroups#order_by}
OrderBy *string `field:"optional" json:"orderBy" yaml:"orderBy"`
// Search groups by name or path.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.9.0/docs/data-sources/groups#search DataGitlabGroups#search}
Search *string `field:"optional" json:"search" yaml:"search"`
// Sort groups' list in asc or desc order. (Requires administrator privileges).
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.9.0/docs/data-sources/groups#sort DataGitlabGroups#sort}
Sort *string `field:"optional" json:"sort" yaml:"sort"`
// Limit to top level groups, excluding all subgroups.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.9.0/docs/data-sources/groups#top_level_only DataGitlabGroups#top_level_only}
TopLevelOnly interface{} `field:"optional" json:"topLevelOnly" yaml:"topLevelOnly"`
}
type DataGitlabGroupsGroups ¶
type DataGitlabGroupsGroups struct {
}
type DataGitlabGroupsGroupsList ¶
type DataGitlabGroupsGroupsList 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)
// Creating an iterator for this complex list.
//
// The list will be converted into a map with the mapKeyAttributeName as the key.
// Experimental.
AllWithMapKey(mapKeyAttributeName *string) cdktf.DynamicListTerraformIterator
// Experimental.
ComputeFqn() *string
Get(index *float64) DataGitlabGroupsGroupsOutputReference
// 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 NewDataGitlabGroupsGroupsList ¶
func NewDataGitlabGroupsGroupsList(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) DataGitlabGroupsGroupsList
type DataGitlabGroupsGroupsOutputReference ¶
type DataGitlabGroupsGroupsOutputReference 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
DefaultBranchProtection() *float64
Description() *string
// Experimental.
Fqn() *string
FullName() *string
FullPath() *string
GroupId() *float64
InternalValue() *DataGitlabGroupsGroups
SetInternalValue(val *DataGitlabGroupsGroups)
LfsEnabled() cdktf.IResolvable
Name() *string
ParentId() *float64
Path() *string
PreventForkingOutsideGroup() cdktf.IResolvable
RequestAccessEnabled() cdktf.IResolvable
RunnersToken() *string
// Experimental.
TerraformAttribute() *string
// Experimental.
SetTerraformAttribute(val *string)
// Experimental.
TerraformResource() cdktf.IInterpolatingParent
// Experimental.
SetTerraformResource(val cdktf.IInterpolatingParent)
VisibilityLevel() *string
WebUrl() *string
WikiAccessLevel() *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 NewDataGitlabGroupsGroupsOutputReference ¶
func NewDataGitlabGroupsGroupsOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool) DataGitlabGroupsGroupsOutputReference