Skip to content

Latest commit

 

History

History
1550 lines (955 loc) · 61.3 KB

groupIssueBoard.csharp.md

File metadata and controls

1550 lines (955 loc) · 61.3 KB

groupIssueBoard Submodule

Constructs

GroupIssueBoard

Represents a {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group_issue_board gitlab_group_issue_board}.

Initializers

using HashiCorp.Cdktf.Providers.Gitlab;

new GroupIssueBoard(Construct Scope, string Id, GroupIssueBoardConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config GroupIssueBoardConfig No description.

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.


IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


ConfigRequired

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
AddMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
HasResourceMove No description.
ImportFrom No description.
InterpolationForAttribute No description.
MoveFromId Move the resource corresponding to "id" to this resource.
MoveTo Moves this resource to the target resource given by moveTarget.
MoveToId Moves this resource to the resource corresponding to "id".
PutLists No description.
ResetLabels No description.
ResetLists No description.
ResetMilestoneId No description.

ToString
private string ToString()

Returns a string representation of this construct.

AddOverride
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string

ValueRequired
  • Type: object

OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

NewLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


ResetOverrideLogicalId
private void ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget
private void AddMoveTarget(string MoveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

MoveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

HasResourceMove
private object HasResourceMove()
ImportFrom
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string

ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

MoveFromId
private void MoveFromId(string Id)

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.

IdRequired
  • Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".


MoveTo
private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.


IndexOptional
  • Type: object

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.


MoveToId
private void MoveToId(string Id)

Moves this resource to the resource corresponding to "id".

IdRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".


PutLists
private void PutLists(object Value)
ValueRequired
  • Type: object

ResetLabels
private void ResetLabels()
ResetLists
private void ResetLists()
ResetMilestoneId
private void ResetMilestoneId()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a GroupIssueBoard resource upon running "cdktf plan ".

IsConstruct
using HashiCorp.Cdktf.Providers.Gitlab;

GroupIssueBoard.IsConstruct(object X);

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.

XRequired
  • Type: object

Any object.


IsTerraformElement
using HashiCorp.Cdktf.Providers.Gitlab;

GroupIssueBoard.IsTerraformElement(object X);
XRequired
  • Type: object

IsTerraformResource
using HashiCorp.Cdktf.Providers.Gitlab;

GroupIssueBoard.IsTerraformResource(object X);
XRequired
  • Type: object

GenerateConfigForImport
using HashiCorp.Cdktf.Providers.Gitlab;

GroupIssueBoard.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTF code for importing a GroupIssueBoard resource upon running "cdktf plan ".

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.


ImportToIdRequired
  • Type: string

The construct id used in the generated config for the GroupIssueBoard to import.


ImportFromIdRequired
  • Type: string

The id of the existing GroupIssueBoard that should be imported.

Refer to the {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group_issue_board#import import section} in the documentation of this resource for the id to use


ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the GroupIssueBoard to import is found.


Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack HashiCorp.Cdktf.TerraformStack No description.
Fqn string No description.
FriendlyUniqueId string No description.
TerraformMetaArguments System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
Connection object No description.
Count object No description.
DependsOn string[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
Id string No description.
Lists GroupIssueBoardListsList No description.
GroupInput string No description.
LabelsInput string[] No description.
ListsInput object No description.
MilestoneIdInput double No description.
NameInput string No description.
Group string No description.
Labels string[] No description.
MilestoneId double No description.
Name string No description.

NodeRequired
public Node Node { get; }
  • Type: Constructs.Node

The tree node.


CdktfStackRequired
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.TerraformStack

FqnRequired
public string Fqn { get; }
  • Type: string

FriendlyUniqueIdRequired
public string FriendlyUniqueId { get; }
  • Type: string

TerraformMetaArgumentsRequired
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>

TerraformResourceTypeRequired
public string TerraformResourceType { get; }
  • Type: string

TerraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

ConnectionOptional
public object Connection { get; }
  • Type: object

CountOptional
public object Count { get; }
  • Type: object

DependsOnOptional
public string[] DependsOn { get; }
  • Type: string[]

ForEachOptional
public ITerraformIterator ForEach { get; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; }
  • Type: object[]

IdRequired
public string Id { get; }
  • Type: string

ListsRequired
public GroupIssueBoardListsList Lists { get; }

GroupInputOptional
public string GroupInput { get; }
  • Type: string

LabelsInputOptional
public string[] LabelsInput { get; }
  • Type: string[]

ListsInputOptional
public object ListsInput { get; }
  • Type: object

MilestoneIdInputOptional
public double MilestoneIdInput { get; }
  • Type: double

NameInputOptional
public string NameInput { get; }
  • Type: string

GroupRequired
public string Group { get; }
  • Type: string

LabelsRequired
public string[] Labels { get; }
  • Type: string[]

MilestoneIdRequired
public double MilestoneId { get; }
  • Type: double

NameRequired
public string Name { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.

TfResourceTypeRequired
public string TfResourceType { get; }
  • Type: string

Structs

GroupIssueBoardConfig

Initializer

using HashiCorp.Cdktf.Providers.Gitlab;

new GroupIssueBoardConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Group,
    string Name,
    string[] Labels = null,
    object Lists = null,
    double MilestoneId = null
};

Properties

Name Type Description
Connection object No description.
Count object No description.
DependsOn HashiCorp.Cdktf.ITerraformDependable[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
Group string The ID or URL-encoded path of the group owned by the authenticated user.
Name string The name of the board.
Labels string[] The list of label names which the board should be scoped to.
Lists object lists block.
MilestoneId double The milestone the board should be scoped to.

ConnectionOptional
public object Connection { get; set; }
  • Type: object

CountOptional
public object Count { get; set; }
  • Type: object

DependsOnOptional
public ITerraformDependable[] DependsOn { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformDependable[]

ForEachOptional
public ITerraformIterator ForEach { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; set; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; set; }
  • Type: object[]

GroupRequired
public string Group { get; set; }
  • Type: string

The ID or URL-encoded path of the group owned by the authenticated user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group_issue_board#group GroupIssueBoard#group}


NameRequired
public string Name { get; set; }
  • Type: string

The name of the board.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group_issue_board#name GroupIssueBoard#name}


LabelsOptional
public string[] Labels { get; set; }
  • Type: string[]

The list of label names which the board should be scoped to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group_issue_board#labels GroupIssueBoard#labels}


ListsOptional
public object Lists { get; set; }
  • Type: object

lists block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group_issue_board#lists GroupIssueBoard#lists}


MilestoneIdOptional
public double MilestoneId { get; set; }
  • Type: double

The milestone the board should be scoped to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group_issue_board#milestone_id GroupIssueBoard#milestone_id}


GroupIssueBoardLists

Initializer

using HashiCorp.Cdktf.Providers.Gitlab;

new GroupIssueBoardLists {
    double LabelId = null,
    double Position = null
};

Properties

Name Type Description
LabelId double The ID of the label the list should be scoped to.
Position double The explicit position of the list within the board, zero based.

LabelIdOptional
public double LabelId { get; set; }
  • Type: double

The ID of the label the list should be scoped to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group_issue_board#label_id GroupIssueBoard#label_id}


PositionOptional
public double Position { get; set; }
  • Type: double

The explicit position of the list within the board, zero based.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group_issue_board#position GroupIssueBoard#position}


Classes

GroupIssueBoardListsList

Initializers

using HashiCorp.Cdktf.Providers.Gitlab;

new GroupIssueBoardListsList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
WrapsSet bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


WrapsSetRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
AllWithMapKey Creating an iterator for this complex list.
ComputeFqn No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
Get No description.

AllWithMapKey
private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName)

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

MapKeyAttributeNameRequired
  • Type: string

ComputeFqn
private string ComputeFqn()
Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext

ToString
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get
private GroupIssueBoardListsOutputReference Get(double Index)
IndexRequired
  • Type: double

the index of the item to return.


Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
InternalValue object No description.

CreationStackRequired
public string[] CreationStack { get; }
  • Type: string[]

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.


FqnRequired
public string Fqn { get; }
  • Type: string

InternalValueOptional
public object InternalValue { get; }
  • Type: object

GroupIssueBoardListsOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Gitlab;

new GroupIssueBoardListsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
ComplexObjectIndex double the index of this item in the list.
ComplexObjectIsFromSet bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


ComplexObjectIndexRequired
  • Type: double

the index of this item in the list.


ComplexObjectIsFromSetRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
ComputeFqn No description.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
ResetLabelId No description.
ResetPosition No description.

ComputeFqn
private string ComputeFqn()
GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string

Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext

ToString
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetLabelId
private void ResetLabelId()
ResetPosition
private void ResetPosition()

Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
Id double No description.
LabelIdInput double No description.
PositionInput double No description.
LabelId double No description.
Position double No description.
InternalValue object No description.

CreationStackRequired
public string[] CreationStack { get; }
  • Type: string[]

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.


FqnRequired
public string Fqn { get; }
  • Type: string

IdRequired
public double Id { get; }
  • Type: double

LabelIdInputOptional
public double LabelIdInput { get; }
  • Type: double

PositionInputOptional
public double PositionInput { get; }
  • Type: double

LabelIdRequired
public double LabelId { get; }
  • Type: double

PositionRequired
public double Position { get; }
  • Type: double

InternalValueOptional
public object InternalValue { get; }
  • Type: object