`repositoryCollaborator` Submodule

Constructs

RepositoryCollaborator

Represents a {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/repository_collaborator github_repository_collaborator}.

Initializers

using HashiCorp.Cdktf.Providers.Github;

new RepositoryCollaborator(Construct Scope, string Id, RepositoryCollaboratorConfig Config);

Name	Type	Description
`Scope`	`Constructs.Construct`	The scope in which to define this construct.
`Id`	`string`	The scoped construct ID.
`Config`	`RepositoryCollaboratorConfig`	No description.

`Scope`^Required

Type: Constructs.Construct

The scope in which to define this construct.

`Id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`Config`^Required

Type: RepositoryCollaboratorConfig

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".
`ResetId`	No description.
`ResetPermission`	No description.
`ResetPermissionDiffSuppression`	No description.

`ToString`

private string ToString()

Returns a string representation of this construct.

`AddOverride`

private void AddOverride(string Path, object Value)

`Path`^Required

Type: string

`Value`^Required

Type: object

`OverrideLogicalId`

private void OverrideLogicalId(string NewLogicalId)

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

`NewLogicalId`^Required

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.

`MoveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`HasResourceMove`

private object HasResourceMove()

`ImportFrom`

private void ImportFrom(string Id, TerraformProvider Provider = null)

`Id`^Required

Type: string

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

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.

`Id`^Required

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.

`MoveTarget`^Required

Type: string

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

`Index`^Optional

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".

`Id`^Required

Type: string

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

`ResetId`

private void ResetId()

`ResetPermission`

private void ResetPermission()

`ResetPermissionDiffSuppression`

private void ResetPermissionDiffSuppression()

Static Functions

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

`IsConstruct`

using HashiCorp.Cdktf.Providers.Github;

RepositoryCollaborator.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.

`X`^Required

Type: object

Any object.

`IsTerraformElement`

using HashiCorp.Cdktf.Providers.Github;

RepositoryCollaborator.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformResource`

using HashiCorp.Cdktf.Providers.Github;

RepositoryCollaborator.IsTerraformResource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using HashiCorp.Cdktf.Providers.Github;

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

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

`Scope`^Required

Type: Constructs.Construct

The scope in which to define this construct.

`ImportToId`^Required

Type: string

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

`ImportFromId`^Required

Type: string

The id of the existing RepositoryCollaborator that should be imported.

Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/repository_collaborator#import import section} in the documentation of this resource for the id to use

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the RepositoryCollaborator 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.
`InvitationId`	`string`	No description.
`IdInput`	`string`	No description.
`PermissionDiffSuppressionInput`	`object`	No description.
`PermissionInput`	`string`	No description.
`RepositoryInput`	`string`	No description.
`UsernameInput`	`string`	No description.
`Id`	`string`	No description.
`Permission`	`string`	No description.
`PermissionDiffSuppression`	`object`	No description.
`Repository`	`string`	No description.
`Username`	`string`	No description.

`Node`^Required

public Node Node { get; }

Type: Constructs.Node

The tree node.

`CdktfStack`^Required

public TerraformStack CdktfStack { get; }

Type: HashiCorp.Cdktf.TerraformStack

`Fqn`^Required

public string Fqn { get; }

Type: string

`FriendlyUniqueId`^Required

public string FriendlyUniqueId { get; }

Type: string

`TerraformMetaArguments`^Required

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

Type: System.Collections.Generic.IDictionary<string, object>

`TerraformResourceType`^Required

public string TerraformResourceType { get; }

Type: string

`TerraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

`Connection`^Optional

public object Connection { get; }

Type: object

`Count`^Optional

public object Count { get; }

Type: object

`DependsOn`^Optional

public string[] DependsOn { get; }

Type: string[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; }

Type: object[]

`InvitationId`^Required

public string InvitationId { get; }

Type: string

`IdInput`^Optional

public string IdInput { get; }

Type: string

`PermissionDiffSuppressionInput`^Optional

public object PermissionDiffSuppressionInput { get; }

Type: object

`PermissionInput`^Optional

public string PermissionInput { get; }

Type: string

`RepositoryInput`^Optional

public string RepositoryInput { get; }

Type: string

`UsernameInput`^Optional

public string UsernameInput { get; }

Type: string

`Id`^Required

public string Id { get; }

Type: string

`Permission`^Required

public string Permission { get; }

Type: string

`PermissionDiffSuppression`^Required

public object PermissionDiffSuppression { get; }

Type: object

`Repository`^Required

public string Repository { get; }

Type: string

`Username`^Required

public string Username { get; }

Type: string

Constants

Name	Type	Description
`TfResourceType`	`string`	No description.

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

RepositoryCollaboratorConfig

Initializer

using HashiCorp.Cdktf.Providers.Github;

new RepositoryCollaboratorConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Repository,
    string Username,
    string Id = null,
    string Permission = null,
    object PermissionDiffSuppression = 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.
`Repository`	`string`	The GitHub repository.
`Username`	`string`	The user to add to the repository as a collaborator.
`Id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/repository_collaborator#id RepositoryCollaborator#id}.
`Permission`	`string`	The permission of the outside collaborator for the repository.
`PermissionDiffSuppression`	`object`	Suppress plan diffs for triage and maintain. Defaults to 'false'.

`Connection`^Optional

public object Connection { get; set; }

Type: object

`Count`^Optional

public object Count { get; set; }

Type: object

`DependsOn`^Optional

public ITerraformDependable[] DependsOn { get; set; }

Type: HashiCorp.Cdktf.ITerraformDependable[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; set; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; set; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; set; }

Type: object[]

`Repository`^Required

public string Repository { get; set; }

Type: string

The GitHub repository.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/repository_collaborator#repository RepositoryCollaborator#repository}

`Username`^Required

public string Username { get; set; }

Type: string

The user to add to the repository as a collaborator.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/repository_collaborator#username RepositoryCollaborator#username}

`Id`^Optional

public string Id { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/repository_collaborator#id RepositoryCollaborator#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.

`Permission`^Optional

public string Permission { get; set; }

Type: string

The permission of the outside collaborator for the repository.

Must be one of 'pull', 'push', 'maintain', 'triage' or 'admin' or the name of an existing custom repository role within the organization for organization-owned repositories. Must be 'push' for personal repositories. Defaults to 'push'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/repository_collaborator#permission RepositoryCollaborator#permission}

`PermissionDiffSuppression`^Optional

public object PermissionDiffSuppression { get; set; }

Type: object

Suppress plan diffs for triage and maintain. Defaults to 'false'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/repository_collaborator#permission_diff_suppression RepositoryCollaborator#permission_diff_suppression}

Files

repositoryCollaborator.csharp.md

Latest commit

History

repositoryCollaborator.csharp.md

File metadata and controls

repositoryCollaborator Submodule

Constructs